機能の概要
テナント内のユーザーの備考情報を変更します。変更後の設定が反映されるまでには時間がかかる場合があります。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
PUT /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/description
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラウドデータベースインスタンスID | obcluster-***** |
| tenantId | String | はい | テナントID | t4louaeei**** |
| userName | String | はい | ユーザー名 |
Query
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Body
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| description | String | はい | ユーザーの説明 | |
| host | String | いいえ | ユーザーのホスト |
戻り値
パラメータ名 |
型 |
説明 |
|---|---|---|
| requestId | String | リクエストID |
| success | Boolean | リクエストが成功したかどうか |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
-X PUT \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/description?requestId={requestId}' \
-H 'Content-Type: application/json' \
--data '{"description":"ユーザーの説明情報","host":"%"}'
レスポンス例
JSON 形式
{
"requestId": "xxxxxx",
"success": true
}