機能の概要
このAPIは、指定されたOceanBase Cloudデータベースインスタンスを削除するために使用されます。この操作により、インスタンス内のすべてのデータが削除され、復元はできませんので、ご注意ください。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
DELETE /api/v2/instances
リクエストパラメータ
Query
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。リクエストの追跡に使用されます。 | d04eabba**** |
Body
リクエストボディは必須です。
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | いいえ | リクエストID。リクエストの追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
| instanceId | String | いいえ | OceanBaseクラスタID | obcluster-***** |
| dryRun | Boolean | いいえ | 事前チェックを行うかどうかを示します。 | false |
戻り値
パラメータ名 |
パラメータタイプ |
説明 |
サンプル値 |
|---|---|---|---|
| success | Boolean | 成功したかどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Object | 業務データ(object) | なし |
| cost | Number | 所要時間 | 1.0 |
| server | String | サーバーアドレス。通常はOBServerノードのIPです | 10.0.0.10 |
| requestId | String | リクエストID | d04eabba**** |
| totalCount | Number | 総レコード数。 | 100.0 |
| extra | Object | 拡張情報。 | {} |
dataオブジェクトのフィールド
パラメータ名 |
パラメータタイプ |
説明 |
サンプル値 |
|---|---|---|---|
| requestId | String | リクエストID | d04eabba**** |
| jobKey | String | 非同期タスクキー。 | env |
| instanceId | String | OceanBaseクラスタID | obcluster-***** |
| dryRun | Boolean | 事前チェックを行うかどうかを示します。 | false |
| dryRunResult | Boolean | 事前チェックの結果 | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
例
リクエスト例
curl --request DELETE \
-u '<Your AccessKey ID:AccessKey Secret>' \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: {projectId}' \
--data '{"requestId": "{requestId}", "instanceId": "{instanceId}", "dryRun": false}' \
'https://api-cloud.oceanbase.com/api/v2/instances?requestId={requestId}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON 形式
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": {
"requestId": "d04eabba****",
"jobKey": "env",
"instanceId": "obcluster-*****",
"dryRun": false,
"dryRunResult": true,
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Invalid parameter"
},
"cost": 1.0,
"server": "10.0.0.10",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": {}
}