查询某个 OceanBase 集群的拓扑信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | Oceanbase 集群 ID。 | ob317v4uif**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
"InstanceTopology": {
"Tenants": [
{
"TenantId": "t33h8y08k****",
"TenantName": "pay_online",
"TenantCpu": 2,
"TenantMemory": 10,
"TenantMode": "Oracle",
"TenantZones": [
{
"TenantZoneRole": "ReadWrite",
"IsPrimaryTenantZone": "true",
"TenantZoneId": "cn-hangzhou-h",
"Units": [
{
"UnitId": "1002",
"UnitStatus": "ONLINE",
"NodeId": "i-bp16niirq4zdmgvm****",
"UnitCpu": 2,
"UnitMemory": 10,
"EnableMigrateUnit": true,
"ManualMigrate": true,
"EnableCancelMigrateUnit": true,
"UnitDataSize": 10,
"ReplicaType": ""
}
]
}
],
"TenantStatus": "ONLINE",
"TenantDeployType": "multiple",
"TenantUnitNum": 1,
"PrimaryZoneDeployType": "RANDOM"
}
],
"Zones": [
{
"ZoneId": "cn-hangzhou-i",
"Region": "cn-hangzhou",
"ZoneDisk": "200 GB",
"Nodes": [
{
"NodeId": "i-bp16niirq4zdmgvm****",
"NodeCopyId": 1,
"NodeStatus": "ONLINE",
"NodeResource": [
{
"Cpu": {
"UsedCpu": 4,
"TotalCpu": 14
},
"Memory": {
"UsedMemory": 10,
"TotalMemory": 70
},
"DiskSize": {
"TotalDiskSize": 400,
"UsedDiskSize": 200
}
}
],
"ReplicaType": "",
"FullCopyId": 0,
"ReadOnlyCopyId": 0
}
],
"ZoneResource": {
"DiskSize": {
"MaxDiskUsedPercent": 0.14,
"MaxDiskUsedObServer": [
"i-bp1fhj23fs32dfbg4****"
]
}
}
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2023-12-26 | OpenAPI 返回结构发生变更 | 看变更集 | ||
| ||||
2022-09-28 | OpenAPI 返回结构发生变更 | 看变更集 | ||
| ||||
2021-08-19 | 新增 OpenAPI | 看变更集 |