機能の概要
このAPIは、指定されたOceanBaseクラスタ内のテナント情報を変更するために使用されます。
注意
テナントの仕様を変更して拡張する場合、クラスタが十分な利用可能リソースを持っている必要があります。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
PUT /api/v2/instances/{instanceId}/tenants/{tenantId}
リクエストパラメータ
Query
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラウドデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | String | はい | テナントID。 | t33h8y08k**** |
Body
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| unitNum | Integer | はい | テナントのユニット数。 | 2 |
| cpu | Integer | はい | テナントのCPUサイズ、単位：コア数(Cores)。 | 2 |
| memory | Integer | はい | テナントメモリサイズ、単位GiB。 | 10 |
戻り値
名前 |
タイプ |
説明 |
例 |
|---|---|---|---|
| data | object | テナント情報。 | |
| tenantId | String | テナントID。 | t33h8y08k**** |
例
リクエスト例
curl -v --location \
--digest -u 'xxx:xxx' \
--request PUT \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants
-H 'X-Ob-Project-Id: <プロジェクトID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
{
"success":true,
"data":{
"tenantId":"テナントID"
},
"requestId":"uuid"
}