Overview
You can call this API to get a backup set of a specified backup task.
API details
Constraints
The caller must have an AccessKey for accessing APIs of multiple clouds. 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/{backupTaskId}
Request parameters
Path
| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | String | Yes | The ID of the instance. |
| backupTaskId | String | Yes | The ID of the backup task. |
Body
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| checkBackupSetDownloadEnable | Boolean | No | Specifies whether to check whether a backup set can be downloaded. This parameter is required for the backup set download scenario. | false |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| data | Object | The information about the backup set. | - |
| backupMode | String | The backup mode. | PHYSICAL_BACKUP |
| backupObjectType | String | The backup object type. | CLUSTER |
| backupSetId | String | The ID of the backup set. | bak-******** |
| checkpoint | String | The time point of the backup set. | 2026-01-19T10:32:28Z |
| dataBackupMode | String | The data backup mode. | FULL_BACKUP |
| dataBackupSize | Double | The size of the data backup, in GB. | 0.06 |
| dataVersion | Integer | The data version number. | 1 |
| downloadEnabled | Boolean | Indicates whether the backup set can be downloaded. | false |
| downloadTaskId | Integer | The ID of the download task. | -1 |
| endTime | String | The end time. | 2026-01-19T10:32:49Z |
| startTime | String | The start time. | 2026-01-19T10:30:53Z |
| status | String | The status. | DONE |
| tenantBackupSetList | Array | The list of tenant backup sets. | - |
| - backupMode | String | The backup mode. | PHYSICAL_BACKUP |
| - backupObjectType | String | The backup object type. | TENANT |
| - backupSetId | String | The ID of the backup set. | bak-********-1002 |
| - checkpoint | String | The time point of the backup set. | 2026-01-19T10:32:28Z |
| - dataBackupMode | String | The data backup mode. | FULL_BACKUP |
| - dataBackupSize | Double | The size of the data backup, in GB. | 0.06 |
| - dataVersion | Integer | The data version number. | 126000001 |
| - downloadEnabled | Boolean | Indicates whether the backup set can be downloaded. | false |
| - downloadTaskId | Integer | The ID of the download task. | -1 |
| - endTime | String | The end time. | 2026-01-19T10:32:40Z |
| - startTime | String | The start time. | 2026-01-19T10:31:09Z |
| - status | String | The status. | DONE |
| - tenantId | String | The ID of the tenant. | txxx |
| - tenantName | String | The name of the tenant. | test1 |
| - triggerMode | String | The trigger mode. | BACKUP_NOW |
| - validity | String | The validity. | VALID |
| tenantId | String | The ID of the tenant. | sys |
| tenantName | String | The name of the tenant. | test |
| triggerMode | String | The trigger mode. | BACKUP_NOW |
| validity | String | The validity. | VALID |
Examples
Request example
curl --digest -u 'ak:sk' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/data/sets/{backupTaskId}'
Response example
JSON format
{
"data": {
"backupMode": "PHYSICAL_BACKUP",
"backupObjectType": "CLUSTER",
"backupSetId": "bak-********",
"checkpoint": "2026-01-19T10:32:28Z",
"dataBackupMode": "FULL_BACKUP",
"dataBackupSize": 0.06,
"dataVersion": 1,
"downloadEnabled": false,
"downloadTaskId": -1,
"endTime": "2026-01-19T10:32:49Z",
"startTime": "2026-01-19T10:30:53Z",
"status": "DONE",
"tenantBackupSetList": [
{
"backupMode": "PHYSICAL_BACKUP",
"backupObjectType": "TENANT",
"backupSetId": "bak-********-1002",
"checkpoint": "2026-01-19T10:32:28Z",
"dataBackupMode": "FULL_BACKUP",
"dataBackupSize": 0.06,
"dataVersion": 126000001,
"downloadEnabled": false,
"downloadTaskId": -1,
"endTime": "2026-01-19T10:32:40Z",
"startTime": "2026-01-19T10:31:09Z",
"status": "DONE",
"tenantId": "txxx",
"tenantName": "test1",
"triggerMode": "BACKUP_NOW",
"validity": "VALID"
}
],
"tenantId": "sys",
"tenantName": "*",
"triggerMode": "BACKUP_NOW",
"validity": "VALID"
},
"requestId": "2wewqe1232",
"success": true
}