Features
This API deletes a specified backup set download task. After deletion, the task is removed from the task list and cannot be recovered. Exercise caution when you call this API.
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
DELETE /api/v2/instances/{instanceId}/backup/link/{downloadTaskId}
Request parameters
Path
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| instanceId | String | Yes | OceanBase cluster ID. | obcluster-***** |
| downloadTaskId | Integer | Yes | Download task ID. | xxxxxx |
Query
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | String | Yes | Request ID, used for tracking. | d04eabba**** |
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 | Boolean | Business data (object). | None |
| 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 DELETE \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/link/{downloadTaskId}?requestId=d04eabba****'
Response example
JSON format
{
"success": true,
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Invalid parameter",
"data": true,
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}