適用対象の説明
現在のバージョンでは、スタンバイクラスタでのユーザー削除はサポートされていません。
機能の概要
このAPIは、1つまたは複数のデータベースアカウントリストを削除するために使用されます。
注意
テナントユーザー削除APIが正常に呼び出されると、ユーザーは即座に削除され、ログインできなくなります。業務への影響を避けるため、当該ユーザーが不要であることを確認してください。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDおよびAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
DELETE /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers
リクエストパラメータ
パスパラメータ
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | string | はい | OceanBaseクラスタID | obcluster-***** |
| tenantId | string | はい | テナントID | t4louaeei**** |
リクエストボディパラメータ
パラメータ名 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| users | string | はい | 削除するユーザー名のリスト、JSON配列形式 | ["user1", "user2"] |
実行結果
パラメータ名 |
型 |
説明 |
|---|---|---|
| success | boolean | 操作の成功・失敗を示します |
例
リクエスト例
curl -v --request DELETE \
--digest -u '<Your AK:SK>' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers' \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <Project ID>' \
--data '{"users": ["user1", "user2"]}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定したプロジェクトIDが一致していることを確認してください。
実行結果例
JSON形式
{
"success": true
}