DescribeInstanceTopology - 查询集群拓扑信息 - 云数据库 OceanBase

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
oceanbase:DescribeInstanceTopology	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	Oceanbase 集群 ID。	ob317v4uif****

返回参数

名称	类型	描述	示例值
	object	请求的返回结果。
RequestId	string	请求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
InstanceTopology	object	集群的拓扑信息。
Tenants	array<object>	租户列表信息。
Tenants	object	请求的返回结果。
TenantId	string	租户 ID。	t33h8y08k****
TenantName	string	租户名称。	pay_online
TenantCpu	float	租户 CPU，单位：核。	2
TenantMemory	float	租户内存大小，单位：GB。	10
TenantMode	string	租户模式。 Oracle：Oracle 模式。 MySQL：MySQL 模式。	Oracle
TenantZones	array<object>	租户的可用区列表信息。
TenantZones	object	请求的返回结果。
TenantZoneRole	string	可用区的访问角色。 ReadWrite：可读可写； ReadOnly：只读。	ReadWrite
IsPrimaryTenantZone	boolean	是否为主可用区。	true
TenantZoneId	string	可用区 ID。	cn-hangzhou-h
Units	array<object>	资源节点信息列表
Units	object	请求的返回结果。
UnitId	string	资源节点 ID。	1002
UnitStatus	string	资源节点的状态。 ONLINE: 运行中； IMMIGRATING：迁入中； EMIGRATING: 迁出中； CANCEL_EMIGRATING: 取消迁入中； CANCEL_EMIGRATING：取消迁出中； DELETING：删除中。	ONLINE
NodeId	string	资源节点所在的 OBServer 节点 ID。	i-bp16niirq4zdmgvm****
UnitCpu	float	资源节点 CPU，单位：核。	2
UnitMemory	float	资源节点内存大小，单位：GB。	10
EnableMigrateUnit	boolean	是否可做迁移。	true
ManualMigrate	boolean	是否为手动迁移。	true
EnableCancelMigrateUnit	boolean	是否可以取消迁移。该字段只对正在手动迁入中或手动迁出中的 unit 有效。	true
UnitDataSize	long	Unit 使用的数据量大小。	10
ReplicaType	string	副本类型。 OceanBase 集群监控根据副本类型设置节点过滤条件。默认不传, 可用于 OceanBase 监控或查询访问代理监控，查询 OceanBase 监控时，表示查询所有副本类型节点的监控数据。 FULL，仅对 OceanBase 监控生效，表示只查询全功能副本节点上的监控数据。 READONLY，仅对 OceanBase 监控生效，表示只查询只读副本节点上的监控数据。	FULL
LogicalZone	string	副本 ID	cn-hangzhou-h-z0
ReplicaType	string	租户的副本类型	FULL
ReadOnlyReplicaType	string	只读副本类型	ROW_STORE
TenantStatus	string	租户状态。 PENDING_CREATE: 创建中。 RESTORE: 恢复中。 ONLINE: 运行中。 SPEC_MODIFYING: 规格修改中。 ALLOCATING_INTERNET_ADDRESS: 公网地址分配中。 PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中。 PRIMARY_ZONE_MODIFYING: 切主可用区中。 PARAMETER_MODIFYING: 参数修改中。 WHITE_LIST_MODIFING: 白名单修改中。	ONLINE
TenantDeployType	string	租户的部署类型。 multiple：多机房。 single：单机房。 dual：双机房。	multiple
TenantUnitNum	integer	租户的 unit 个数。	1
PrimaryZoneDeployType	string	主可用区部署模式。枚举值： RANDOM：RANDOM。 STATIC：STATIC。	RANDOM
TenantDiskSize	float	租户数据量	2
TenantUnitCpu	float	租户单节点 CPU	4
TenantUnitMemory	float	租户单节点内存	16
Zones	array<object>	集群的可用区信息。
Zones	object	请求的返回结果。
ZoneId	string	可用区 ID。	cn-hangzhou-i
Region	string	地域 ID。	cn-hangzhou
ZoneDisk	string	可用区的存储容量。	200 GB
Nodes	array<object>	节点列表信息。
Nodes	object	请求的返回结果。
NodeId	string	节点 ID。	i-bp16niirq4zdmgvm****
NodeCopyId	long	节点归属的副本 ID。	1
NodeStatus	string	节点运行状态。	ONLINE
NodeResource	object	节点资源列表信息。
Cpu	object	节点 CPU 资源信息。
UsedCpu	float	节点已使用的 CPU，单位：核。	4
TotalCpu	integer	节点总的 CPU，单位：核。	14
Memory	object	节点内存资源信息。
UsedMemory	float	节点已使用的内存，单位：GB。	10
TotalMemory	long	节点的总内存，单位：GB。	70
DiskSize	object	节点存储资源信息。
TotalDiskSize	double	节点总存储空间，单位：GB。	100
UsedDiskSize	double	节点已使用的存储空间，单位：GB。	50
ReplicaType	string	副本类型。支持的副本类型： FULL READONLY	FULL
FullCopyId	long	全功能副本 ID。	1
ReadOnlyCopyId	long	只读副本 ID。	1
LogicalZone	string	副本 ID	cn-hangzhou-h-z0
ReadOnlyReplicaType	string	只读副本类型	ROW_STORE
ZoneResource	object	可用区信息。
DiskSize	object	节点存储资源信息。
MaxDiskUsedPercent	double	磁盘使用率最大值（百分比）。	0.14
MaxDiskUsedObServer	array	磁盘服务器使用率最大值。
MaxDiskUsedObServer	string	磁盘服务器使用率最大值。	i-bp1fhj23fs32dfbg4****
Replicas	array<object>	副本信息
Replicas	object
LogicalZone	string	副本 ID	cn-hangzhou-h-z0
NodeNum	integer	副本节点数	1
ZoneLogicalName	string	副本地域	cn-hangzhou-h
ZoneRegionName	string	副本可用区	cn-hangzhou-h
ReplicaResource	object	副本资源信息
Memory	object	副本内存资源
UsedMemory	long	副本已使用内存	16
TotalMemory	long	副本总内存	32
DiskSize	object	副本数据盘资源
UsedDiskSize	float	副本已使用数据量	50
TotalDiskSize	long	副本总数据量	100
Cpu	object	副本 CPU 资源
TotalCpu	integer	副本总 CPU	16
UsedCpu	integer	副本已使用 CPU	8
ZoneLogicalId	integer	副本编号	1
ReplicaType	string	副本类型	FULL
Status	string	副本状态，返回枚举类型（ACTIVE/INACTIVE/UNKNOWN）	ACTIVE
ReadOnlyReplicaType	string	只读副本类型	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-29	OpenAPI 返回结构发生变更	查看变更详情
2024-07-04	OpenAPI 返回结构发生变更	查看变更详情
2024-06-06	OpenAPI 返回结构发生变更	查看变更详情
2024-04-15	OpenAPI 返回结构发生变更	查看变更详情
2023-12-26	OpenAPI 返回结构发生变更	查看变更详情
2022-09-28	OpenAPI 返回结构发生变更	查看变更详情
2021-08-19	新增 OpenAPI	查看变更详情