機能の概要
このAPIは、指定されたOceanBaseクラスタでテナントを作成する際の制約を確認するために使用します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenantCreateConstraints
リクエストパラメータ
Query
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラウドデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | String | はい | テナントID。 | t33h8y08k**** |
| tenantModel | string | はい | テナントモード。 現在サポートされているモードは、Oracleモード(Oracle)とMySQLモード(MySQL)です。 |
Oracle |
戻り値
名前 |
タイプ |
説明 |
例 |
|---|---|---|---|
| data | object | テナント情報。 | |
| charsetList | List |
サポートされている文字セット名（例：utf8mb4、gbk）。 | utf8 |
| defaultTimeZone | String | デフォルトのタイムゾーン。 | Shanghai |
| tenantModeList | List |
テナントの互換モード文字列（例：MySQL、Oracle）。 | Oracle |
| timeZoneList | List |
利用可能なタイムゾーンのリスト。 | |
| timeZone | String | タイムゾーンID（例：UTC+8、Asia/Shanghai）。 | Africa/Addis_Ababa |
| description | String | そのタイムゾーンのテキスト説明。 | (GMT+3:00) Africa/Addis_Ababa |
| zoneList | List |
利用可能なメインゾーン。 | |
| name | String | Zoneの名前またはID。 | cn-hangzhou-h |
| replicaType | String | レプリカタイプ（例：FULLフル機能レプリカ、READONLY読み取り専用レプリカ）。 | FULL |
| region | String | そのZoneが属するリージョン。 | cn-hangzhou |
| role | String | このゾーンが担当するロール（例：ReadWriteは読み書き、ReadOnlyは読み取り専用）。 | ReadWrite |
| tenantZoneReplicas | List |
ゾーンの詳細なレプリカ情報。 | |
| zoneReplicaType | String | レプリカの具体的なタイプ。 | FULL |
| zoneNodes | Integer | このゾーン内のノード数。 | 1 |
| logicZoneName | String | ロジックゾーン名。 | cn-hangzhou-h |
| readOnlyReplicaType | String | 読み取り専用レプリカの具体的なサブタイプ（例：COLUMNARは列指向レプリカ）。 | COLUMNAR |
| unitInfoList | List UNITInfoDto> | リソースユニット(Unit)の仕様に関する詳細情報リスト。 | [ { "name": "unit1", "cpu": 2, "memory": 4 } ] |
例
リクエスト例
--digest -u 'xxx:xxx' \
--request GET \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenantCreateConstraints
-H 'X-Ob-Project-Id: <プロジェクトID>'
説明
- プロジェクトIDはプロジェクトを一意に識別するものです。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- インスタンスIDが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"data":{
"charsetList":[
"utf8mb4",
"gbk"
],
"defaultTimeZone":"Asia/Shanghai",
"tenantModeList":[
"Oracle",
"MySQL"
],
"timeZoneList":[
{
"description":"(GMT0:00) Africa/Abidjan",
"timeZone":"Africa/Abidjan"
},
{
"description":"(GMT0:00) Africa/Accra",
"timeZone":"Africa/Accra"
},
{
"description":"(GMT+3:00) Africa/Addis_Ababa",
"timeZone":"Africa/Addis_Ababa"
}
],
"zoneList":[
{
"name":"cn-hangzhou-h",
"replicaType":"FULL"
}
]
},
"requestId":"d17468e6-acb5-481f-924b-5b7705899221",
"success":true
}