機能の概要
このAPIは、指定されたクラスタの変更可能な読み取り専用レプリカのゾーンリストを照会し、関連リソースの詳細情報を返します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/availableRoZones
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
Query
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
| openRequest | String | はい | Open requestパラメータ | なし |
戻り結果
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | Object | 戻りデータ | - |
| AvailableRoZones | arrayList | 利用可能な読み取り専用レプリカのリスト | - |
| LogicalZone | String | レプリカの論理ゾーン | cn-hangzhou-i-ro-z0 |
| ReadOnlyReplicaType | String | 読み取り専用レプリカのタイプ：
|
ROW_STORE |
| ReadOnlyZoneOperations | Object | 読み取り専用レプリカの操作 | - |
| Permitted | Boolean | サポートされているかどうか | true |
| Deletable | Object | 削除操作 | 詳細は下表を参照 |
| Up | Object | アップグレード操作 | - |
| Down | Object | ダウングレード操作 | - |
| ReplicaAliasName | String | レプリカ表示名 | I-1 |
| ZoneCopyId | Integer | レプリカID | 1 |
| ZoneId | String | zone id | cn-hangzhou-i |
| ZoneReplicaType | String | レプリカタイプ | READONLY |
| readonlyInstanceId | String | 読み取り専用インスタンスID | obroxxx |
| requestId | String | リクエストID | e4f17bc5-faad-42b8-b6e0-ca1e4e2a485a |
| success | Boolean | 成功かどうか | true |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/availablerozones'
レスポンス例
JSON形式
{
"data":{
"AvailableRoZones":[
{
"LogicalZone":"cn-hangzhou-i-ro-z0",
"ReadOnlyReplicaType":"ROW_STORE",
"ReadOnlyZoneOperations":{
"Deletable":{
"Permitted":true,
"Reason":"NULL"
},
"Down":{
"RoDisksize":{
"Message":"ディスクサイズが最小限に達し、サイズ縮小を続行できません",
"Permitted":false,
"Reason":"READONLY_NODE_DISK_SIZE_IS_ALREADY_MIN"
},
"RoNodenum":{
"Message":"読み取り専用レプリカノード数が最小限に達しました",
"Permitted":false,
"Reason":"READONLY_NODE_NUM_IS_ALREADY_MIN"
},
"RoSpec":{
"Message":"より小さい仕様がないため、仕様のサイズ縮小を行えません",
"Permitted":false,
"Reason":"NO_MORE_SMALLER_SPEC"
}
},
"Permitted":true,
"Up":{
"RoDisksize":{
"Message":"ディスクサイズが上限に達し、拡張できません",
"Permitted":false,
"Reason":"READONLY_NODE_DISK_SIZE_IS_ALREADY_MAX"
},
"RoNodenum":{
"Message":"読み取り専用レプリカノード数が上限値に達しました。",
"Permitted":false,
"Reason":"READONLY_NODE_NUM_IS_ALREADY_MAX"
},
"RoSpec":{
"Permitted":true,
"Reason":"NULL"
}
}
},
"ReplicaAliasName":"I-1",
"ZoneCopyId":1,
"ZoneId":"cn-hangzhou-i",
"ZoneReplicaType":"READONLY",
"readonlyInstanceId":"obroxxx"
}
]
},
"requestId":"e4f17bc5-faad-42b8-b6e0-ca1e4e2a485a",
"success":true
}