機能の概要
テナント内の指定されたユーザーのロック状態を変更します。例えば、アクティブなユーザーをロックして、一時的にログインや操作を行えないようにすることができます。変更操作を送信した後、設定が反映されるまでには時間がかかる場合があります。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
PUT /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/status
リクエストパラメータ
Path
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラウドデータベースインスタンスID | obcluster-***** |
| tenantId | String | はい | テナントID | t4louaeei**** |
| userName | String | はい | ユーザー名 | testuser |
Query
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Body
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| userStatus | String | はい | ユーザーステータス | LOCKED |
実行結果
パラメータ名 |
パラメータタイプ |
説明 |
サンプル値 |
|---|---|---|---|
| requestId | String | リクエストID | b34ae828-5bb0-4ca6-aa76-5fa387c5f3d2 |
| success | Boolean | リクエストの成功・失敗 | true |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X PUT \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/status?requestId={requestId}' \
-H 'Content-Type: application/json' \
--data '{"userStatus":"LOCKED"}'
レスポンス例
JSON形式
{
"requestId": "b34ae828-5bb0-4ca6-aa76-5fa387c5f3d2",
"success": true
}