DescribeInstanceTopology - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the topology of an OceanBase cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The status of the node.	ob317v4uif****

Response parameters

Parameter	Type	Description	Example
	object	The information of node resources.
RequestId	string	The information about the CPU resources of the node.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
InstanceTopology	object	The number of CPU cores used by the node.
Tenants	object []	The total number of CPU cores for the node.
TenantId	string	The size of used memory of the node, in GB.	t33h8y08k****
TenantName	string	The total memory size of the node, in GB.	pay_online
TenantCpu	float	The information about the memory resources of the node.	2
TenantMemory	float	The total storage space of the node, in GB.	10
TenantMode	string	The size of used storage space of the node, in GB.	Oracle
TenantZones	object []	The information about the storage resources of the node.
TenantZoneRole	string	The information of zones.	ReadWrite
IsPrimaryTenantZone	string	The maximum disk usage, in percentage.	true
TenantZoneId	string	The server with the highest disk usage.	cn-hangzhou-h
Units	object []	The information about the storage resources.
UnitId	string	The topology of the cluster.	1002
UnitStatus	string	You can call this operation to query the topology of an OceanBase cluster.	ONLINE
NodeId	string	It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples.	i-bp16niirq4zdmgvm****
UnitCpu	float	Alibaba Cloud CLI	2
UnitMemory	float	The ID of the tenant.	10
EnableMigrateUnit	boolean	The return result of the request.	true
ManualMigrate	boolean	The return result of the request.	true
EnableCancelMigrateUnit	boolean	Indicates whether the migration can be canceled. This field is valid only for units that are being manually immigrated or emigrated.	true
UnitDataSize	long	The operation that you want to perform. Set the value to DescribeInstanceTopology.	10
TenantStatus	string	The size of used memory of the node, in GB.	ONLINE
TenantDeployType	string	The name of the tenant.	multiple
TenantUnitNum	integer	The number of CPU cores of the tenant.	1
PrimaryZoneDeployType	string	The server with the highest disk usage. Enumeration Value: RANDOM: RANDOM. STATIC: STATIC.	RANDOM
Zones	object []	The information about resource units.
ZoneId	string	The information of the tenant.	cn-hangzhou-i
Region	string	The zone information of the cluster.	cn-hangzhou
ZoneDisk	string	The information about the memory resources of the node.	200 GB
Nodes	object []	The ID of the region.
NodeId	string	The ID of the resource unit.	i-bp16niirq4zdmgvm****
NodeCopyId	long	The information of zones.	1
NodeStatus	string	The ID of the OBServer where the resource unit resides.	ONLINE
NodeResource	object []	The ID of the node.
Cpu	object	The memory size of the tenant, in GB.
UsedCpu	float	Indicates whether migration can be performed.	4
TotalCpu	integer	The size of used storage space of the node, in GB.	14
Memory	object	The role to access the zone. Valid values: ReadWrite: a role that has the read and write privileges. ReadOnly: a role that has only the read-only privilege.
UsedMemory	float	The information of node resources.	10
TotalMemory	long	The ID of the replica node.	70
DiskSize	object	The information about the CPU resources of the node.
TotalDiskSize	double	The deployment type of the primary zone.	400
UsedDiskSize	double	The status of the tenant. PENDING_CREATE: The tenant is being created. RESTORE: The tenant is being recovered. ONLINE: The tenant is running. SPEC_MODIFYING: The specification of the tenant is being modified. ALLOCATING_INTERNET_ADDRESS: An Internet address is being allocated. PENDING_OFFLINE_INTERNET_ADDRESS: The Internet address is being disabled. PRIMARY_ZONE_MODIFYING: The tenant is switching to a new primary zone. PARAMETER_MODIFYING: Parameters are being modified. WHITE_LIST_MODIFYING: The whitelist is being modified.	200
ZoneResource	object	Example 1
DiskSize	object
MaxDiskUsedPercent	double	DescribeInstanceTopology	0.14

Examples

Sample success responses

JSONformat

{
  "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
              }
            ]
          }
        ],
        "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
                }
              }
            ]
          }
        ],
        "ZoneResource": {
          "DiskSize": {
            "MaxDiskUsedPercent": 0.14,
            "MaxDiskUsedObServer": [
              "i-bp1fhj23fs32dfbg4****"
            ]
          }
        }
      }
    ]
  }
}