Overview
You can call this API to query the list of data backup sets of an OceanBase cluster in a specified time period. You can also check whether the backup sets can be downloaded.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
GET /api/v2/instances/{instanceId}/backup/data/sets
Request parameters
Path
| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase cluster. |
Query
| Parameter | Type | Required | Description |
|---|---|---|---|
| requestId | String | Yes | The request ID for tracking. |
| startTime | String | No | The start time (UTC). |
| endTime | String | No | The end time (UTC). |
| pageNumber | Integer | No | The page number for pagination. |
| pageSize | Integer | No | The number of items per page. |
| checkBackupSetDownloadEnable | Boolean | No | Specifies whether to check whether the backup sets can be downloaded. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| data | Object | The data of the backup sets. |
| data.dataList | Array<Object> |
The list of backup sets. |
| data.dataList[].backupSetId | String | The ID of the backup set. |
| data.dataList[].backupMode | String | The backup mode. |
| data.dataList[].backupObjectType | String | The type of the backup object. |
| data.dataList[].checkpoint | String | The checkpoint time. |
| data.dataList[].dataBackupMode | String | The data backup mode. |
| data.dataList[].dataBackupSize | Number | The size of the data backup (GiB). |
| data.dataList[].dataVersion | Integer | The data version. |
| data.dataList[].downloadEnabled | Boolean | Specifies whether the backup set can be downloaded. |
| data.dataList[].downloadTaskId | Integer | The ID of the download task. -1 indicates that no download task has been created. |
| data.dataList[].status | String | The status of the backup set. |
| data.dataList[].startTime | String | The start time. |
| data.dataList[].endTime | String | The end time. |
| data.dataList[].storageClass | String | The storage type. |
| data.dataList[].tenantId | String | The ID of the tenant. |
| data.dataList[].tenantName | String | The name of the tenant. |
| data.dataList[].triggerMode | String | The trigger mode. |
| data.dataList[].validity | String | The validity. |
| data.dataList[].tenantBackupSetList | Array<Object> |
The list of tenant backup sets. |
| data.dataList[].tenantBackupSetList[].backupSetId | String | The ID of the tenant backup set. |
| data.dataList[].tenantBackupSetList[].backupMode | String | The backup mode of the tenant. |
| data.dataList[].tenantBackupSetList[].backupObjectType | String | The type of the backup object of the tenant. |
| data.dataList[].tenantBackupSetList[].checkpoint | String | The checkpoint time of the tenant. |
| data.dataList[].tenantBackupSetList[].dataBackupMode | String | The data backup mode of the tenant. |
| data.dataList[].tenantBackupSetList[].dataBackupSize | Number | The size of the data backup of the tenant (GiB). |
| data.dataList[].tenantBackupSetList[].dataVersion | Integer | The data version of the tenant. |
| data.dataList[].tenantBackupSetList[].downloadEnabled | Boolean | Specifies whether the tenant backup set can be downloaded. |
| data.dataList[].tenantBackupSetList[].downloadTaskId | Integer | The ID of the tenant download task. |
| data.dataList[].tenantBackupSetList[].status | String | The status of the tenant backup set. |
| data.dataList[].tenantBackupSetList[].startTime | String | The start time of the tenant backup set. |
| data.dataList[].tenantBackupSetList[].endTime | String | The end time of the tenant backup set. |
| data.dataList[].tenantBackupSetList[].storageClass | String | The storage type of the tenant. |
| data.dataList[].tenantBackupSetList[].tenantId | String | The ID of the tenant. |
| data.dataList[].tenantBackupSetList[].tenantName | String | The name of the tenant. |
| data.dataList[].tenantBackupSetList[].triggerMode | String | The trigger mode of the tenant. |
| data.dataList[].tenantBackupSetList[].validity | String | The validity of the tenant. |
| data.total | Integer | The total number of backup sets. |
| requestId | String | The request ID. |
| success | Boolean | Indicates whether the request was successful. |
Examples
Request example
curl --digest -u '<Your ak:sk>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/data/sets' \
-G \
-d 'requestId={requestId}' \
-d 'startTime={startTime}' \
-d 'endTime={endTime}' \
-d 'pageNumber={pageNumber}' \
-d 'pageSize={pageSize}' \
-d 'checkBackupSetDownloadEnable={checkBackupSetDownloadEnable}'
Response example
JSON format
{
"data": {
"dataList": [
{
"backupMode": "PHYSICAL_BACKUP",
"backupObjectType": "CLUSTER",
"backupSetId": "bak-7aqvtc4ugvuo",
"checkpoint": "2025-12-03T12:57:32Z",
"dataBackupMode": "FULL_BACKUP",
"dataBackupSize": 0.04,
"dataVersion": 1,
"downloadEnabled": true,
"downloadTaskId": -1,
"endTime": "2025-12-03T12:58:07Z",
"startTime": "2025-12-03T12:55:35Z",
"status": "DONE",
"storageClass": "standard",
"tenantBackupSetList": [
{
"backupMode": "PHYSICAL_BACKUP",
"backupObjectType": "TENANT",
"backupSetId": "bak-7aqvtc4ugvuo-1002",
"checkpoint": "2025-12-03T12:57:32Z",
"dataBackupMode": "FULL_BACKUP",
"dataBackupSize": 0.04,
"dataVersion": 123000325,
"downloadEnabled": true,
"downloadTaskId": -1,
"endTime": "2025-12-03T12:57:42Z",
"startTime": "2025-12-03T12:55:47Z",
"status": "DONE",
"storageClass": "standard",
"tenantId": "t7amdemq4iu9s",
"tenantName": "gyh",
"triggerMode": "BACKUP_NOW",
"validity": "VALID"
}
],
"tenantId": "sys",
"tenantName": "*",
"triggerMode": "BACKUP_NOW",
"validity": "VALID"
}
],
"total": 1
},
"requestId": "df209ed9-ae31-4e9e-bf75-76385afaadf9",
"success": true
}