Features
This API queries the details of a backup set download task for a specified OceanBase Cloud database instance, including its download URL, status, backup set size, and URL validity period. You can call this API to obtain the information required to download the backup file.
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/link/{downloadTaskId}
Request parameters
Path
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| instanceId | String | Yes | OceanBase cluster ID. | obcluster-***** |
| downloadTaskId | Integer | Yes | Download task ID. | 1 |
Query
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | String | Yes | Request ID used for tracking. | d04eabba**** |
Response parameters
Name |
Type |
Description |
Example value |
|---|---|---|---|
| success | Boolean | Whether the request was successful. | true |
| errorCode | String | Error code. | INVALID_PARAMETER |
| errorMessage | String | Error message. | Invalid parameter |
| data | Object | Response data. | N/A |
| cost | Number | Time required to process the request. | 1.0 |
| server | String | Server address, typically the IP address of an OBServer node. | 10.0.0.10 |
| requestId | String | Request ID. | d04eabba**** |
| totalCount | Number | Total number of records. | 100.0 |
| extra | Object | Extended information. | {} |
Data object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| downloadTaskId | Integer | Download task ID. | 1 |
| downloadTaskStatus | String | Download task status. | ONLINE |
| downloadTaskCreateTime | String | Download task creation time. | 2026-02-25 15:40:43+00:00 |
| backupRestorableTime | String | Point in time to which the backup set can be restored. | 2026-02-25 15:40:43+00:00 |
| backupSetId | String | Backup set ID. | backup_1**** |
| compressedBackupSetSize | Number | Compressed backup set size. | 200.0 |
| internalUrl | String | Internal download URL. | https://internal.example.com/backup/link |
| urlExpiredTime | String | Download URL expiration time. | 2026-02-25 15:40:43+00:00 |
| urlAliveTime | Integer | Download URL validity period. | 1 |
Examples
Request example
curl -X GET 'https://api.example.com/api/v2/instances/{instanceId}/backup/link/{downloadTaskId}?requestId=d04eabba****' \
-H 'Authorization: Bearer <your_access_token>'
Response example
JSON format
{
"success": true,
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Invalid parameter",
"data": {
"downloadTaskId": 1,
"downloadTaskStatus": "ONLINE",
"downloadTaskCreateTime": "2026-02-25 15:40:43+00:00",
"backupRestorableTime": "2026-02-25 15:40:43+00:00",
"backupSetId": "backup_1****",
"compressedBackupSetSize": 200.0,
"internalUrl": "https://internal.example.com/backup/link",
"urlExpiredTime": "2026-02-25 15:40:43+00:00",
"urlAliveTime": 1
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}