機能の概要
このAPIは、指定されたOceanBaseクラスタ内の1つまたは複数のテナントを削除するために使用されます。
注意
テナント削除APIが正常に呼び出されると、テナントの削除操作が即座に実行されます。業務への影響を避けるため、対象テナントが不要であることを確認してください。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDおよびAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
DELETE /api/v2/instances/{instanceId}/tenants/{tenantId}
リクエストパラメータ
Query
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラウドデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | String | はい | テナントID。 | t33h8y08k**** |
戻り値
名前 |
タイプ |
説明 |
例 |
|---|---|---|---|
| data | object | テナント情報。 | |
| tenantId | String | テナントID。 | t33h8y08k**** |
例
リクエスト例
curl --request DELETE \
--digest -u 'ak:sk' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId} '
-H 'X-Ob-Project-Id: <プロジェクトID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
戻り値例
JSON形式
{
"success":true,
"data":{
"tenantId":"テナントID"
},
"requestId":"uuid"
}