Overview
Creates a download link for a backup set of the specified OceanBase Cloud database instance. You need to provide the backup set ID, and the system will generate a temporary download task ID. This link can be used to download the backup set file later.
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
POST /api/v2/instances/{instanceId}/backup/link
Request parameters
Path
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| instanceId | String | Yes | OceanBase cluster ID. | obcluster-***** |
Query
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | String | Yes | Request ID used for tracking. | d04eabba**** |
Body
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| instanceId | String | Yes | OceanBase cluster ID. | obcluster-***** |
| backupSetId | String | Yes | Backup set ID. | backup_1**** |
| UID | String | No | User ID. | 20000600**** |
| User_ID | String | No | User ID. | 20000600**** |
| requestId | String | No | Request ID used for tracking. | dc302d76-66b5-48d8-ab53-a035******** |
| callerType | String | No | Caller type. | sub |
| accessKeyId | String | No | AccessKey ID. | ak-xxxxx**** |
| securityToken | String | No | Security token. | sts-token-xxxxxxxx |
| callerUid | String | No | Caller ID. | 20000600**** |
| callerBid | String | No | Caller BID. | xxxxxx |
| stsTokenCallerUid | String | No | UID of the STS token caller. | 20000600**** |
| stsTokenCallerBid | String | No | BID of the STS token caller. | xxxxxx |
| acceptLanguage | String | No | Language used for the request or response. | zh-CN |
| pageNumber | Integer | No | Page number. | 1 |
| pageSize | Integer | No | Number of records per page. | 10 |
| mergedCallerBid | String | No | Merged BID of the caller. | xxxxxx |
Response parameters
Field |
Type |
Description |
Example value |
|---|---|---|---|
| success | Boolean | Indicates whether the request was successful. | true |
| errorCode | String | Error code. | INVALID_PARAMETER |
| errorMessage | String | Error message. | Invalid parameter |
| data | Object | Business data. | None |
| data.downloadTaskId | Integer | Download task ID. | xxxxxx |
| cost | Number | Time consumed. | 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. | {} |
Examples
Request example
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
-X POST \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/link?requestId=d04eabba****' \
-H 'Content-Type: application/json' \
-d '{
"instanceId": "obcluster-*****",
"backupSetId": "backup_1****"
}'
Response example
JSON format
{
"success": true,
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Invalid parameter",
"data": {
"downloadTaskId": 1
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}