適用対象の説明
現在のバージョンでは、スタンバイクラスタからのデータベース削除はサポートされていません。
機能の概要
このAPIは、作成されたデータベースを1つまたは複数削除するために使用します。
注意
データベース削除APIの呼び出しが成功すると、データベースは即座に削除されます。業務への影響を避けるため、対象のデータベースが不要であることを確認してください。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDおよびAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
DELETE /api/v2/instances/{instanceId}/tenants/{tenantId}/databases
リクエストパラメータ
Path
プロパティ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | いいえ | OceanBase CloudインスタンスID。 | ob317v4uif**** |
| tenantId | string | はい | テナントID。 | ob2mr3oae0**** |
Body
プロパティ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | いいえ | OB CloudデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | string | はい | テナントID。 | ob2mr3oae0**** |
| databaseNames | string | はい | データベース名のリスト。JSON形式の配列で、配列内の各要素はデータベース名の文字列です。 | ["d1", "d2"] |
戻り値
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| success | boolean | 削除が成功したかどうか。 | true |
例
リクエスト例
curl -v --request DELETE \
--digest -u '<Your AK:SK>' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/databases' \
-H 'X-Ob-Project-Id: <Project ID>' \
-H 'Content-Type: application/json' \
--data '{"tenantId":"{tenantId}","databaseNames":"[\"default_database\"]"}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
戻り値例
JSON形式
{
"success": true,
"server": "xxx.xxx.x.xxx:xxxx"
}