DescribeInstanceTopology - 查询集群拓扑信息

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oceanbase:DescribeInstanceTopologyget
*全部资源
*

请求参数

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

Oceanbase 集群 ID。

ob317v4uif****

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
InstanceTopologyobject

集群的拓扑信息。

Tenantsarray<object>

租户列表信息。

Tenantsobject

请求的返回结果。

TenantIdstring

租户 ID。

t33h8y08k****
TenantNamestring

租户名称。

pay_online
TenantCpufloat

租户 CPU,单位:核。

2
TenantMemoryfloat

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

10
TenantModestring

租户模式。

  • Oracle:Oracle 模式。
  • MySQL:MySQL 模式。
Oracle
TenantZonesarray<object>

租户的可用区列表信息。

TenantZonesobject

请求的返回结果。

TenantZoneRolestring

可用区的访问角色。

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

是否为主可用区。

true
TenantZoneIdstring

可用区 ID。

cn-hangzhou-h
Unitsarray<object>

资源节点信息列表

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
ReplicaTypestring

副本类型。
OceanBase 集群监控根据副本类型设置节点过滤条件。

  • 默认不传, 可用于 OceanBase 监控或查询访问代理监控,查询 OceanBase 监控时,表示查询所有副本类型节点的监控数据。
  • FULL,仅对 OceanBase 监控生效,表示只查询全功能副本节点上的监控数据。
  • READONLY,仅对 OceanBase 监控生效,表示只查询只读副本节点上的监控数据。
FULL
LogicalZonestring

副本 ID

cn-hangzhou-h-z0
ReplicaTypestring

租户的副本类型

FULL
ReadOnlyReplicaTypestring

只读副本类型

ROW_STORE
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
TenantDiskSizefloat

租户数据量

2
TenantUnitCpufloat

租户单节点 CPU

4
TenantUnitMemoryfloat

租户单节点内存

16
Zonesarray<object>

集群的可用区信息。

Zonesobject

请求的返回结果。

ZoneIdstring

可用区 ID。

cn-hangzhou-i
Regionstring

地域 ID。

cn-hangzhou
ZoneDiskstring

可用区的存储容量。

200 GB
Nodesarray<object>

节点列表信息。

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。

100
UsedDiskSizedouble

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

50
ReplicaTypestring

副本类型。支持的副本类型:

  • FULL
  • READONLY
FULL
FullCopyIdlong

全功能副本 ID。

1
ReadOnlyCopyIdlong

只读副本 ID。

1
LogicalZonestring

副本 ID

cn-hangzhou-h-z0
ReadOnlyReplicaTypestring

只读副本类型

ROW_STORE
ZoneResourceobject

可用区信息。

DiskSizeobject

节点存储资源信息。

MaxDiskUsedPercentdouble

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

0.14
MaxDiskUsedObServerarray

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

MaxDiskUsedObServerstring

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

i-bp1fhj23fs32dfbg4****
Replicasarray<object>

副本信息

Replicasobject
LogicalZonestring

副本 ID

cn-hangzhou-h-z0
NodeNuminteger

副本节点数

1
ZoneLogicalNamestring

副本地域

cn-hangzhou-h
ZoneRegionNamestring

副本可用区

cn-hangzhou-h
ReplicaResourceobject

副本资源信息

Memoryobject

副本内存资源

UsedMemorylong

副本已使用内存

16
TotalMemorylong

副本总内存

32
DiskSizeobject

副本数据盘资源

UsedDiskSizefloat

副本已使用数据量

50
TotalDiskSizelong

副本总数据量

100
Cpuobject

副本 CPU 资源

TotalCpuinteger

副本总 CPU

16
UsedCpuinteger

副本已使用 CPU

8
ZoneLogicalIdinteger

副本编号

1
ReplicaTypestring

副本类型

FULL
Statusstring

副本状态,返回枚举类型(ACTIVE/INACTIVE/UNKNOWN)

ACTIVE
ReadOnlyReplicaTypestring

只读副本类型

ROW_STORE

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-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": "FULL"
              }
            ],
            "LogicalZone": "cn-hangzhou-h-z0",
            "ReplicaType": "FULL",
            "ReadOnlyReplicaType": "ROW_STORE"
          }
        ],
        "TenantStatus": "ONLINE",
        "TenantDeployType": "multiple",
        "TenantUnitNum": 1,
        "PrimaryZoneDeployType": "RANDOM",
        "TenantDiskSize": 2,
        "TenantUnitCpu": 4,
        "TenantUnitMemory": 16
      }
    ],
    "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": 100,
                "UsedDiskSize": 50
              }
            },
            "ReplicaType": "FULL",
            "FullCopyId": 1,
            "ReadOnlyCopyId": 1,
            "LogicalZone": "cn-hangzhou-h-z0",
            "ReadOnlyReplicaType": "ROW_STORE"
          }
        ],
        "ZoneResource": {
          "DiskSize": {
            "MaxDiskUsedPercent": 0.14,
            "MaxDiskUsedObServer": [
              "i-bp1fhj23fs32dfbg4****"
            ]
          }
        }
      }
    ],
    "Replicas": [
      {
        "LogicalZone": "cn-hangzhou-h-z0",
        "NodeNum": 1,
        "ZoneLogicalName": "cn-hangzhou-h",
        "ZoneRegionName": "cn-hangzhou-h",
        "ReplicaResource": {
          "Memory": {
            "UsedMemory": 16,
            "TotalMemory": 32
          },
          "DiskSize": {
            "UsedDiskSize": 50,
            "TotalDiskSize": 100
          },
          "Cpu": {
            "TotalCpu": 16,
            "UsedCpu": 8
          }
        },
        "ZoneLogicalId": 1,
        "ReplicaType": "FULL",
        "Status": "ACTIVE",
        "ReadOnlyReplicaType": "ROW_STORE"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-10-29OpenAPI 返回结构发生变更查看变更详情
2024-07-04OpenAPI 返回结构发生变更查看变更详情
2024-06-06OpenAPI 返回结构发生变更查看变更详情
2024-04-15OpenAPI 返回结构发生变更查看变更详情
2023-12-26OpenAPI 返回结构发生变更查看变更详情
2022-09-28OpenAPI 返回结构发生变更查看变更详情
2021-08-19新增 OpenAPI查看变更详情