機能の概要
このAPIは、指定されたOceanBaseクラスタでテナントを作成する際のメモリ制約を確認するために使用します。
呼び出しの説明
インターフェースの制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenantCreateMemConstraints
リクエストパラメータ
Query
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラウドデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | String | はい | テナントID。 | t33h8y08k**** |
| unitNum | Integer | はい | テナントのユニット数。 | 1 |
| cpu | Integer | はい | テナントのCPUサイズ、単位：コア数(Cores)。 | 2 |
戻り値
名前 |
タイプ |
説明 |
例 |
|---|---|---|---|
| data | object | メモリ情報。 | |
| cpu | Integer | テナントのCPUサイズ、単位：コア数(Cores)。 | 10 |
| maxMem | long | 単一ユニットが申請できる最大メモリサイズ、単位：GiB。 | 55 |
| minMem | long | 単一ユニットが申請するために必要な最小メモリサイズ、単位：GiB。 | 20 |
| unitNum | Integer | テナントのユニット数。 | 1 |
例
リクエスト例
curl -v --location \
--digest -u 'xxx:xxx' \
--request GET \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenantCreateMemConstraints
-H 'X-Ob-Project-Id: <プロジェクトID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定したプロジェクトIDが一致していることを確認してください。
戻り値例
JSON形式
{
"data":{
"cpu":10,
"maxMem":55,
"minMem":20,
"unitNum":1
},
"requestId":"fdcdc581-9f6d-4aae-8448-xxxfdsad",
"success":true
}