機能説明
このAPIは、指定されたOceanBaseクラスタ内のすべての読み取り専用レプリカインスタンスの詳細情報（インスタンス仕様、状態、所属AZなど）を照会するために使用されます。
呼び出し説明
API制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/readonlyInstance
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
Query
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
| physicalZone | String | いいえ | 物理AZ | zone_1 |
戻り結果
パラメータ名 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | Object | 戻りデータ | - |
| instanceId | String | インスタンスID | obxxx |
| readonlyInstances | array | 読み取り専用レプリカ情報 | - |
| clusterArn | String | クラスタARN。 | obc:qcloud:rds:ap-beijing:20000600****:cluster:obxxx |
| region | String | 地域 | このインスタンスに稼働中のテナントが存在するため、この操作は許可されません。 |
| zoneArn | String | 地域ARN | obc:qcloud:rds:ap-beijing:20000600****:zone:obxxx.ap-beijing-3-ro-z0 |
| nodeNum | long | ノード数 | 2 |
| logDiskSize | long | ログディスクサイズ | 60 |
| readOnlyReplicaType | String | 読み取り専用レプリカタイプ：
|
ROW_STORE |
| readonlyInstanceId | String | 読み取り専用レプリカインスタンスID | obxxx |
| zone | string | 物理ゾーン | ap-beijing-3 |
| logicalZone | string | 仮想ゾーン | ap-beijing-3-ro-z0 |
| cpu | integer | CPU数 | 4 |
| mem | integer | メモリサイズ | 16 |
| diskSize | integer | ディスクサイズ | 70 |
| instanceClass | String | スペック | 4C16GB |
| status | String | 読み取り専用インスタンスの状態 | ONLINE |
| requestId | String | リクエストID | 707e9d0d-f332-4255-8ef7-ce1c3f29d01r |
| success | Boolean | リクエストが成功したかどうか | true |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/readonlyInstance?requestId={requestId}&physicalZone={physicalZone}'
レスポンス例
JSON形式
{
"data": {
"instanceId": "obxxx",
"readonlyInstances": [
{
"clusterArn": "obc:qcloud:rds:ap-beijing:20000600****:cluster:obxxx",
"cpu": 4,
"diskSize": 70,
"instanceClass": "4C16G",
"logDiskSize": 60,
"logicalZone": "ap-beijing-3-ro-z0",
"mem": 16,
"nodeNum": 1,
"readOnlyReplicaType": "ROW_STORE",
"readonlyInstanceId": "obxxx",
"region": "ap-beijing",
"status": "ONLINE",
"zone": "ap-beijing-3",
"zoneArn": "obc:qcloud:rds:ap-beijing:20000600****:zone:obxxx.ap-beijing-3-ro-z0"
}
]
},
"requestId": "707e9d0d-f332-4255-8ef7-ce1c3f29d01r",
"success": true
}