機能の概要
このAPIは、指定されたOceanBaseクラスタインスタンスを削除するために使用されます。この操作により、インスタンス内のすべてのデータが削除され、復元はできませんので、ご注意ください。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
DELETE /api/v2/instances
リクエストパラメータ
Query
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。リクエストの追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
Body
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。リクエストの追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
| instanceId | String | はい | 削除するインスタンスID。 | ob677efwh8******** |
| dryRun | Boolean | いいえ | プレフライトリクエストかどうかを示します。trueに設定すると、リクエストパラメータのみが検証され、インスタンスは実際には削除されません。 |
true |
戻り値
パラメータ名 |
パラメータタイプ |
説明 |
例値 |
|---|---|---|---|
| success | boolean | リクエストが成功したかどうか。 | true/false |
| requestId | String | trace | dc302d76-66b5-48d8-ab53-a035********（64ビット） |
例
リクエスト例
curl --request DELETE \
-u '<あなたのAK:SK>' \
-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が一致していることを確認してください。
レスポンス例
リクエスト成功時のレスポンス例：
{
"data": {},
"success": true,
"requestId": "dc302d76-66b5-48d8-ab53-a035********"
}
リクエスト失敗時のレスポンス例：
{
"errorCode": "Params.InstanceName.Invalid",
"errorMessage": "クラスタ名の検証に失敗しました",
"requestId": "cb32942e-bdf2-4d85-a26f-6bf8********",
"success": false
}