機能の概要
このAPIは、指定されたOceanBaseクラスタ内のテナント名を変更するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
PUT /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantName
リクエストパラメータ
パスパラメータ
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラウドデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | String | はい | テナントID。 | t33h8y08k**** |
クエリパラメータ
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | 追跡用のリクエストID。 | dc302d76-66b5-48d8-ab53-a035******** |
リクエストボディパラメータ
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| tenantName | String | はい | 新しいテナント名。 | pay_tenant_new |
| patternCheck | Boolean | いいえ | 名前の形式検証を行うかどうか。 | true |
実行結果
名前 |
タイプ |
説明 |
例 |
|---|---|---|---|
| success | Boolean | リクエストが成功したかどうかを示します。 | true |
| data | Object | 戻されたデータオブジェクトです。 | |
| data.tenantId | String | テナントIDです。 | t33h8y08k**** |
| requestId | String | このリクエストのIDです。 | dc302d76-66b5-48d8-ab53-a035******** |
| server | String | リクエストを処理したサーバーアドレスです。 | xxx.xxx.x.xxx:xxxx |
例
リクエスト例
curl -v --request PUT \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tenantName?requestId={requestId}' \
--digest -u '<Your AK:SK>' \
-H 'X-Ob-Project-Id: {projectId}' \
-H 'Content-Type: application/json' \
--data '{"tenantName": "pay_tenant_new", "patternCheck": true}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- インスタンスIDが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
{
"success": true,
"data": {
"tenantId": "t33h8y08k****"
},
"requestId": "dc302d76-66b5-48d8-ab53-a035********",
"server": "xxx.xxx.x.xxx:xxxx"
}