DescribeDataBackupSet|OceanBase Cloud| docs|Distributed Database

DescribeDataBackupSet

Last Updated：2025-12-19 08:18:21 Updated

Overview

You can call this API to query data backup set information.

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 instance.

Query

Parameter	Type	Required	Description
startTime	String	No	The start time of the task.
endTime	String	No	The end time of the task.
pageNumber	Integer	No	The page number. Default value: 1.
pageSize	Integer	No	The number of items per page. Default value: 10.

Response parameters

Parameter	Type	Description
data	Object	The backup set data.
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 in GiB.
data.dataList[].dataVersion	Integer	The data version.
data.dataList[].downloadEnabled	Boolean	Indicates 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 tenant backup mode.
data.dataList[].tenantBackupSetList[].backupObjectType	String	The type of the tenant backup object.
data.dataList[].tenantBackupSetList[].checkpoint	String	The tenant checkpoint time.
data.dataList[].tenantBackupSetList[].dataBackupMode	String	The tenant data backup mode.
data.dataList[].tenantBackupSetList[].dataBackupSize	Number	The size of the tenant data backup in GiB.
data.dataList[].tenantBackupSetList[].dataVersion	Integer	The tenant data version.
data.dataList[].tenantBackupSetList[].downloadEnabled	Boolean	Indicates 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 tenant trigger mode.
data.dataList[].tenantBackupSetList[].validity	String	The validity of the tenant.
data.total	Integer	The total number of items.
requestId	String	The ID of the request.
success	Boolean	Indicates whether the request was successful.

Examples

Request example

curl --digest -u 'ak:sk' \
  -X GET \
  'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/data/sets' \
  -G -d 'startTime=2025-03-19T20:00:00Z' \
  -d 'endTime=2025-03-19T21:00:00Z' \
  -d 'pageNumber=1' \
  -d 'pageSize=10'

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
}