機能説明
このインターフェースは、テナントが変更可能な読み取り専用レプリカのアベイラビリティゾーンリストを照会し、関連リソースの詳細情報を返すために使用されます。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/availableRoZones
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
| tenantId | String | はい | テナントID | t4louaeei**** |
Query
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID（追跡用） | dc302d76-66b5-48d8-ab53-a035******** |
| openRequest | unknown | はい | Open requestパラメータ | なし |
戻り結果
パラメータ名 |
型 |
説明 |
例値 |
|---|---|---|---|
| data | Object | 返されるデータ | - |
| zonesInfo | Array | 読み取り専用レプリカ情報 | - |
| availableZoneId | String | 読み取り専用レプリカの論理zoneId | ap-beijing-3-ro-z0 |
| cpu | Integer | CPU数 | 4.0 |
| cpuUsed | Integer | 使用済みCPU数 | 0.0 |
| enableCreate | Boolean | 読み取り専用レプリカの作成を許可するかどうか | true |
| memory | Integer | メモリサイズ | 16.0 |
| memoryUsed | Integer | 使用済みメモリサイズ | 0.0 |
| permission | Object | 操作を許可するかどうか | - |
| permitted | Boolean | 権限があるかどうか | true |
| reason | String | 理由 | NULL |
| message | String | メッセージ | - |
| readOnlyReplicaType | String | 読み取り専用レプリカタイプ：
|
ROW_STORE |
| realZoneId | String | 物理ゾーンID | ap-beijing-3 |
| replicaAliasName | String | 読み取り専用レプリカ名 | 3-1 |
| roCreated | Boolean | 読み取り専用レプリカが既に作成されているかどうか | false |
| serverCount | Integer | ノード数 | 2 |
| zoneCopyId | Integer | 読み取り専用レプリカ番号 | 1 |
| zoneReplicaType | String | zoneレプリカタイプ | READONLY |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/availableRoZones?requestId={requestId}&openRequest={openRequest}'
レスポンス例
JSON形式
{
"data":{
"zonesInfo":[
{
"availableZoneId":"ap-beijing-3-ro-z0",
"cpu":4.0,
"cpuUsed":0.0,
"enableCreate":true,
"memory":16.0,
"memoryUsed":0.0,
"permission":{
"permitted":true,
"reason":"NULL"
},
"readOnlyReplicaType":"ROW_STORE",
"realZoneId":"ap-beijing-3",
"replicaAliasName":"3-1",
"roCreated":false,
"serverCount":2,
"zoneCopyId":1,
"zoneReplicaType":"READONLY"
}
]
},
"requestId":"5e65c5ce-9fda-4483-ac4c-d36781b734ef",
"success":true
}