機能の概要
このAPIは、指定されたOceanBase Cloudインスタンスのトポロジー情報を取得します。ゾーンの分布やノード一覧などの詳細情報が含まれます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/topology
リクエストパラメータ
Path
パラメータ |
型 |
必須 |
説明 |
|---|---|---|---|
| instanceId | String | はい | OceanBase CloudインスタンスID |
Query
パラメータ |
型 |
必須 |
説明 |
|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます |
戻り値
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| success | Boolean | 成功かどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Object | 業務データ(object) | N/A |
| cost | Number | 所要時間 | 1.0 |
| server | String | サーバーアドレス、通常はOBServerノードのIPアドレス | 10.0.0.10 |
| requestId | String | リクエストID | d04eabba**** |
| totalCount | Number | 総レコード数。 | 100.0 |
| extra | Object | 拡張情報。 | {} |
dataオブジェクトのフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| instanceId | String | OceanBaseクラスタID | obcluster-***** |
| tenants | Array | テナントリスト。 | [{'tenantName': 'pay_core', 'tenantId': 't4louaeei****'}] |
| zones | Array | ゾーンリスト。カンマ区切り | N/A |
| replicaList | Array | レプリカリスト。 | [{'id': 'resource-123456'}] |
data.replicaList[]要素のフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| logicalZone | String | 論理ゾーン | ap-beijing-3-ro-z0 |
| replicaType | String | レプリカタイプ。FULL、READONLY、またはLOGONLYなど。 | FULL |
| zoneRegionName | String | ゾーンが属するリージョン名。 | test-name |
| zoneLogicalId | Integer | 論理ゾーンID。 | 1 |
| zoneId | String | ゾーンID。 | cn-hangz**** |
| status | String | タスクまたはリソースの現在の状態 | ONLINE |
| nodeNum | Integer | ノード数 | 3 |
| readonlyInstanceId | String | 読み取り専用インスタンスID | obcluster-*****-ro |
| replicaResource | Object | レプリカリソース仕様情報 | N/A |
| replicaResource.cpu | Object | プロセッサコア数または仕様情報。 | N/A |
| replicaResource.cpu.totalCpu | Number | CPU総コア数。 | 4.0 |
| replicaResource.cpu.usedCpu | Number | 使用済みCPUコア数。 | 4.0 |
| replicaResource.memory | Object | リソース仕様のメモリ情報 | N/A |
| replicaResource.memory.totalMemory | Number | メモリ合計量。 | 16.0 |
| replicaResource.memory.usedMemory | Number | 使用済みメモリ。 | 16.0 |
| replicaResource.memory.originalTotalMemory | Number | 変更前メモリ合計量。 | 16.0 |
| replicaResource.memory.unitMemory | Number | ユニットメモリサイズ(GB) | 8.0 |
| replicaResource.memory.hostActualMemory | Number | ホストの実際のメモリサイズ、単位GiB（{@link com.oceanbase.cloud.instance.multicloud.dto.resource.MemoryDoV2}と一致） | 16.0 |
| replicaResource.memory.systemMemory | Number | フラッグシップ版ホストのシステムが使用するメモリ、単位GiB | 16.0 |
| replicaResource.memory.originalHostActualMemory | Number | 元の仕様に対応するホストの実際のメモリサイズ、単位GiB | 16.0 |
| replicaResource.diskSize | Object | ディスクサイズ | N/A |
| replicaResource.diskSize.totalDiskSize | Number | ディスク総容量。 | 200.0 |
| replicaResource.diskSize.usedDiskSize | Number | 使用済みディスク容量。 | 200.0 |
| replicaResource.diskSize.totalDataSize | Number | データ総量。 | 200.0 |
| replicaResource.diskSize.unitDiskSize | Number | ユニットディスクサイズ | 200.0 |
| replicaResource.diskSize.availableDiskSize | Number | ユーザーが実際に利用できるストレージサイズ(単位:GB) | 200.0 |
| readOnlyReplicaType | Object | なし | N/A |
data.tenants[]要素のフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| tenantId | String | テナントID | t4louaeei**** |
| tenantName | String | テナント名 | xxxxxx |
| tenantMode | String | テナントモード。例：MySQLまたはOracle。 | xxxxxx |
| tenantStatus | String | テナントの状態。 | xxxxxx |
| tenantDeployType | String | テナントのデプロイメントタイプ。 | xxxxxx |
| tenantCpu | Number | テナントCPUスペック。 | 1 |
| tenantMemory | Number | テナントメモリスペック。 | 1 |
| tenantUnitNum | Integer | テナントUnit数。 | 1 |
| tenantZones | Array | zone情報 | [{'repli**** |
| tenantCompatibilityMode | String | KVクラスタがHBASE/Tableの場合はこのモード、その他の場合はTenantModeを指定する | xxxxxx |
| parameterTemplate | String | 作成時に渡されたパラメータテンプレート | oltp |
data.tenants[].tenantZones[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| tenantZoneId | String | テナントのゾーンID。 | t4louaeei**** |
| tenantZoneRole | String | テナントレプリカが担当するロール。 | cn-hangz**** |
| isPrimaryTenantZone | Boolean | テナントのプライマリゾーンかどうか。 | true |
| unitInfoList | Array | Unit情報のリスト | [{'id': 'resource-123456'}] |
data.tenants[].tenantZones[].unitInfoList[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| unitId | String | Unit idパラメータ | resource**** |
| serverIp | String | Server ipパラメータ | 10.0.0.10 |
| serverPort | Integer | Serverポート。 | 2881 |
| replicaType | String | レプリカタイプ。例：FULL、READONLY、LOGONLY。 | FULL |
| sn | String | Sn | example-value |
| isPrimary | Boolean | プライマリゾーンまたはリーダーレプリカかどうか。 | true |
| cpu | Number | プロセッサコア数またはスペック情報。 | 4.0 |
| memory | Number | リソーススペックのメモリ情報 | 16.0 |
| dataSize | Number | データサイズ | 200.0 |
| logDiskSize | Number | ログディスクサイズ | 200.0 |
| zone | String | ゾーン。 | cn-hangzhou-i |
| logicalZone | String | 論理ゾーン | ap-beijing-3-ro-z0 |
| tenantObId | Integer | OceanBaseテナントID。 | 1 |
| tenantId | String | テナントID | t4louaeei**** |
| resourcePoolId | Integer | リソースプールID。 | 1 |
| migrateFromServerIp | String | Unit移行元ServerのIPアドレス。 | 10.0.0.11 |
| migrateFromServerPort | Integer | Unit移行元Serverのポート。 | 2881 |
| migrateFromServerSn | String | Unit移行元Serverのシリアル番号。 | server-sn-001 |
| manualMigrate | Integer | ユニット移行が手動かどうかを示します。 | 0 |
| enableMigrateUnit | Boolean | ユニット移行の開始を許可するかどうかを示します。 | true |
| enableCancelMigrateUnit | Boolean | ユニット移行のキャンセルを許可するかどうかを示します。 | true |
| status | String | タスクまたはリソースの現在の状態を示します。 | ONLINE |
data.zones[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| zoneId | String | ゾーンIDです。 | cn-hangz**** |
| region | String | 一部のオブジェクトストレージベンダーでは必須です。例：S3 | ap-guangzhou |
| zoneDisk | String | ゾーンのデータディスク容量の表示値です。 | 200 |
| logicZoneId | String | 論理ゾーンIDです。 | resource**** |
| nodes | Array | ノードのリストです。 | [{'id': 'resource-123456'}] |
data.zones[].nodes[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| nodeId | String | ノード識別子。 | xxxxxx |
| serverIp | String | Server IPアドレスパラメータ | 10.0.0.10 |
| nodeCopyId | Integer | トポロジ内でのノードレプリカの順序番号。 | 1 |
| nodeStatus | String | ノードの現在の実行状態。 | ONLINE |
| replicaType | String | レプリカタイプ。FULL、READONLY、またはLOGONLYなどが該当します。 | FULL |
| nodeResource | Object | ノードのリソース仕様情報 | N/A |
| nodeResource.cpu | Object | なし | N/A |
| nodeResource.memory | Object | なし | N/A |
| nodeResource.diskSize | Object | なし | N/A |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/topology?requestId={requestId}'
レスポンス例
JSON 形式
{
"success": true,
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Invalid parameter",
"data": {
"instanceId": "obcluster-*****",
"tenants": [
{
"tenantId": "t4louaeei****",
"tenantName": "xxxxxx",
"tenantMode": "xxxxxx",
"tenantStatus": "xxxxxx",
"tenantDeployType": "xxxxxx",
"tenantCpu": 1,
"tenantMemory": 1,
"tenantUnitNum": 1,
"tenantZones": [
{
"tenantZoneId": "t4louaeei****",
"tenantZoneRole": "cn-hangz****",
"isPrimaryTenantZone": true,
"unitInfoList": [
{
"unitId": "resource****",
"serverIp": "xxx.xxx.x.xxx:xxx",
"serverPort": 2881,
"replicaType": "FULL",
"sn": "example-value",
"isPrimary": true,
"cpu": 4.0,
"memory": 16.0,
"dataSize": 200.0,
"logDiskSize": 200.0,
"zone": "cn-hangzhou-i",
"logicalZone": "ap-beijing-3-ro-z0",
"tenantObId": 1,
"tenantId": "t4louaeei****",
"resourcePoolId": 1,
"migrateFromServerIp": "xxx.xxx.x.xxx:xxx",
"migrateFromServerPort": 2881,
"migrateFromServerSn": "server-sn-001",
"manualMigrate": 0,
"enableMigrateUnit": true,
"enableCancelMigrateUnit": true,
"status": "ONLINE"
}
]
}
],
"tenantCompatibilityMode": "xxxxxx",
"parameterTemplate": "oltp"
}
],
"zones": [
{
"zoneId": "cn-hangz****",
"region": "ap-guangzhou",
"zoneDisk": "200",
"logicZoneId": "resource****",
"nodes": [
{
"nodeId": "xxxxxx",
"serverIp": "xxx.xxx.x.xxx:xxx",
"nodeCopyId": 1,
"nodeStatus": "ONLINE",
"replicaType": "FULL",
"nodeResource": {
"cpu": "xxxxxx",
"memory": "xxxxxx",
"diskSize": "xxxxxx"
}
}
]
}
],
"replicaList": [
{
"logicalZone": "ap-beijing-3-ro-z0",
"replicaType": "FULL",
"zoneRegionName": "test-name",
"zoneLogicalId": 1,
"zoneId": "cn-hangz****",
"status": "ONLINE",
"nodeNum": 3,
"readonlyInstanceId": "obcluster-*****-ro",
"replicaResource": {
"cpu": {
"totalCpu": 4.0,
"usedCpu": 4.0
},
"memory": {
"totalMemory": 16.0,
"usedMemory": 16.0,
"originalTotalMemory": 16.0,
"unitMemory": 8.0,
"hostActualMemory": 16.0,
"systemMemory": 16.0,
"originalHostActualMemory": 16.0
},
"diskSize": {
"totalDiskSize": 200.0,
"usedDiskSize": 200.0,
"totalDataSize": 200.0,
"unitDiskSize": 200.0,
"availableDiskSize": 200.0
}
},
"readOnlyReplicaType": "xxxxxx"
}
]
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}