適用対象の説明
現在のバージョンでは、スタンバイクラスタでのパスワード変更はサポートされていません。
機能の概要
このAPIは、テナント内の指定されたデータベースアカウントのログインパスワードを変更するために使用されます。パスワードの変更は即時に反映され、既存の接続には影響しません。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
PUT /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/password
リクエストパラメータ
パスパラメータ
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | string | はい | OceanBase CloudデータベースインスタンスID。 | obcluster-***** |
| tenantId | string | はい | テナントID。 | t4louaeei**** |
| userName | string | はい | ユーザー名。 | なし |
クエリパラメータ
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | string | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
リクエストボディパラメータ
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| userPassword | string | はい | データベースアカウントのアクセスパスワードです。 大文字英字、小文字英字、数字、特殊文字の3種類を含み、長さは10～32文字である必要があります。 特殊文字：!@#$%^&* ()_ +-= | ob********* |
実行結果
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| success | boolean | 変更が成功したかどうかを示します。 | true |
例
リクエスト例
curl -X PUT \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <プロジェクトID>' \
-u '<Your AK:SK>' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/password?requestId={requestId}' \
-d '{
"userPassword": "yourNewPassword123!"
}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
実行結果例
JSON形式
{
"requestId": "xxxxxx",
"success": true,
"server": "xxx.xxx.x.xxx:xxxx"
}