文档

DescribeInstanceTopology - 查询集群拓扑信息

更新时间:

查询某个 OceanBase 集群的拓扑信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

Oceanbase 集群 ID。

ob317v4uif****

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
InstanceTopologyobject

集群的拓扑信息。

Tenantsobject []

租户列表信息。

TenantIdstring

租户 ID。

t33h8y08k****
TenantNamestring

租户名称。

pay_online
TenantCpufloat

租户 CPU,单位:核。

2
TenantMemoryfloat

租户内存大小,单位:GB。

10
TenantModestring

租户模式。

  • Oracle:Oracle 模式。
  • MySQL:MySQL 模式。
Oracle
TenantZonesobject []

租户的可用区列表信息。

TenantZoneRolestring

可用区的访问角色。

  • ReadWrite:可读可写;
  • ReadOnly:只读。
ReadWrite
IsPrimaryTenantZoneboolean

是否为主可用区。

true
TenantZoneIdstring

可用区 ID。

cn-hangzhou-h
Unitsobject []

资源节点信息列表

UnitIdstring

资源节点 ID。

1002
UnitStatusstring

资源节点的状态。

  • ONLINE: 运行中;
  • IMMIGRATING:迁入中;
  • EMIGRATING: 迁出中;
  • CANCEL_EMIGRATING: 取消迁入中;
  • CANCEL_EMIGRATING:取消迁出中;
  • DELETING:删除中。
ONLINE
NodeIdstring

资源节点所在的 OBServer 节点 ID。

i-bp16niirq4zdmgvm****
UnitCpufloat

资源节点 CPU,单位:核。

2
UnitMemoryfloat

资源节点内存大小,单位:GB。

10
EnableMigrateUnitboolean

是否可做迁移。

true
ManualMigrateboolean

是否为手动迁移。

true
EnableCancelMigrateUnitboolean

是否可以取消迁移。
该字段只对正在手动迁入中或手动迁出中的 unit 有效。

true
UnitDataSizelong

Unit 使用的数据量大小。

10
TenantStatusstring

租户状态。

  • PENDING_CREATE: 创建中。
  • RESTORE: 恢复中。
  • ONLINE: 运行中。
  • SPEC_MODIFYING: 规格修改中。
  • ALLOCATING_INTERNET_ADDRESS: 公网地址分配中。
  • PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中。
  • PRIMARY_ZONE_MODIFYING: 切主可用区中。
  • PARAMETER_MODIFYING: 参数修改中。
  • WHITE_LIST_MODIFING: 白名单修改中。
ONLINE
TenantDeployTypestring

租户的部署类型。

  • multiple:多机房。
  • single:单机房。
  • dual:双机房。
multiple
TenantUnitNuminteger

租户的 unit 个数。

1
PrimaryZoneDeployTypestring

主可用区部署模式。

枚举值:
  • RANDOMRANDOM
  • STATICSTATIC
RANDOM
Zonesobject []

集群的可用区信息。

ZoneIdstring

可用区 ID。

cn-hangzhou-i
Regionstring

地域 ID。

cn-hangzhou
ZoneDiskstring

可用区的存储容量。

200 GB
Nodesobject []

节点列表信息。

NodeIdstring

节点 ID。

i-bp16niirq4zdmgvm****
NodeCopyIdlong

节点归属的副本 ID。

1
NodeStatusstring

节点运行状态。

ONLINE
NodeResourceobject []

节点资源列表信息。

Cpuobject

节点 CPU 资源信息。

UsedCpufloat

节点已使用的 CPU,单位:核。

4
TotalCpuinteger

节点总 CPU,单位:核。

14
Memoryobject

节点内存资源信息。

UsedMemoryfloat

节点已使用的内存,单位:GB。

10
TotalMemorylong

节点总内存,单位:GB。

70
DiskSizeobject

节点存储资源信息。

TotalDiskSizedouble

节点总存储空间,单位:GB。

400
UsedDiskSizedouble

节点已使用的存储空间,单位:GB。

200
ZoneResourceobject

可用区信息。

DiskSizeobject

节点存储资源信息。

MaxDiskUsedPercentdouble

磁盘使用率最大值(百分比)。

0.14
MaxDiskUsedObServerarray

磁盘服务器使用率最大值。

string

磁盘服务器使用率最大值。

i-bp1fhj23fs32dfbg4****

示例

正常返回示例

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****"
            ]
          }
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-15OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-12-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-09-28OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-08-19新增 OpenAPI看变更集
  • 本页导读 (0)