機能の概要
指定されたバックアップセットのダウンロードタスクを削除します。削除後、そのタスクはタスクリストから削除され、復元することはできません。この操作は慎重に実行してください。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
DELETE /api/v2/instances/{instanceId}/backup/link/{downloadTaskId}
リクエストパラメータ
Path
パラメータ |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
| downloadTaskId | Integer | はい | ダウンロードタスクIDパラメータ | xxxxxx |
Query
パラメータ |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | トレース用のリクエストID | d04eabba**** |
戻り値
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| success | Boolean | 成功したかどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Boolean | 業務データ(object) | None |
| cost | Number | 所要時間 | 1.0 |
| server | String | サーバーアドレス、通常はOBServerノードのIP | 10.0.0.10 |
| requestId | String | リクエストID | d04eabba**** |
| totalCount | Number | 総レコード数。 | 100.0 |
| extra | Object | 拡張情報。 | {} |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
-X DELETE \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/link/{downloadTaskId}?requestId=d04eabba****'
レスポンス例
JSON 形式
{
"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": "{}"
}