You can call this operation to query the information about the backup sets of an OceanBase cluster.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| oceanbase:DescribeDataBackupSet | none | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the OceanBase cluster. | ob317v4uif**** |
| Status | string | No | The status of the backup sets to be queried. Enumeration Value:
| DONE |
| BackupObjectType | string | No | The object type of the backup sets to be queried. Enumeration Value:
| tenant |
| StartTime | string | Yes | The backup start time, in the format of yyyy-MM-dd T HH:mm:ss Z (UTC time). | 2022-12-27T16:00:00Z |
| EndTime | string | No | The backup end time. | 2023-01-06T15:59:59Z |
| PageNumber | integer | No | The page number, which takes effect in a pagination query. | 1 |
| PageSize | integer | No | The number of rows to return on each page.
| 10 |
Response parameters
Examples
Sample success responses
JSONformat
{
"TotalCount": 2,
"RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
"Data": [
{
"EndTime": "2023-04-13T03:38:10Z",
"Status": "RUNNING",
"Type": "manual",
"StartTime": "2020-05-22T17:04:18",
"DataSize": 31457280,
"Policy": "automated",
"SetId": 0,
"Method": "logical",
"Checkpoint": "2023-05-15T07:11:08Z",
"DataVersion": 1678847020352,
"BackupObjectType": "cluster",
"BackupObjects": [
{
"ClusterName": "test-****way",
"TenantName": "ob2mr3oae0****",
"DatabaseTablesList": [
{
"Database": "sms_pre",
"Tables": [
"{'Tables': []}"
]
}
]
}
],
"BackupResults": [
{
"ClusterName": "container-opa-****-02",
"TenantName": "ob2mr3oae0****\n",
"TableBackupResults": [
{
"Database": "order_ce****_online",
"Table": "tr_sale_order_****",
"Status": "RUNNING",
"Message": "Create tag success"
}
]
}
],
"DownloadTaskStatus": "not_exist",
"DownloadTaskId": 0,
"Validity": "VALID",
"Progress": 52,
"StorageClass": "standard"
}
]
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 500 | InternalError | The request processing has failed due to some unknown error. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-04-22 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-02-02 | The Error code has changed | View Change Details |