DescribeDBInstanceTopology - PolarDB

Retrieves the topology of a PolarDB-X instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDBInstanceTopology	A required parameter. Set the value to DescribeDBInstanceTopology.
RegionId	String	Yes	cn-hangzhou	The ID of the region where the instance is located.
DBInstanceName	String	Yes	pxc-********	The instance ID.
StartTime	String	No	2021-10-21T10:30:45Z 04:00:00	The beginning of the time range to query the historical topology of the instance. Specify the time in the yyyy-MM-dd HH:mm:ss format.
EndTime	String	No	2021-10-22T10:30:45Z 04:00:00	The end of the time range to query the historical topology of the instance. Specify the time in the yyyy-MM-dd HH:mm:ss format.
MinuteSimple	Boolean	No	true	Specifies whether to query the historical topology.

Response parameters

Parameter	Type	Example	Description
RequestId	String	C458B1E8-1683-3645-B154-6BA32080EEA	The request ID.
Data	Object		The data structure.
LogicInstanceTopology	Object		The topology information.
DBInstanceName	String	pxc-sprcym7g7w****	The instance name.
DBInstanceCreateTime	String	2021-10-21T10:30:45Z 04:00:00	The time when the instance was created. The time is in the yyyy-MM-dd HH:mm:ss format.
MaintainStartTime	String	04:00:00	The start time of the O&M window. The time is in the HH:mm:ss format.
MaintainEndTime	String	05:00:00	The end time of the O&M window. The time is in the HH:mm:ss format.
LockReason	String	overdue payment	The reason why the instance is locked.
DBInstanceStatus	Integer	8	The instance status.
LockMode	Integer	0	The lock status. Valid values: 0: unlocked 1: locked
EngineVersion	String	2.0	The database engine version. Default value: 2.0.
DBInstanceStorage	Integer	1	The number of storage nodes.
DBInstanceConnType	String	lvs	The load balancing method. The value `lvs` indicates that Server Load Balancer is used.
DBInstanceId	String	304726047	The instance ID.
Engine	String	polarx	The database engine. Default value: polarx.
DBInstanceDescription	String	pxc-sprcym7******	The instance description.
DBInstanceStatusDescription	String	TDE_MODIFYING	The description of the instance status.
Items	Array of Items		The list of nodes.
DBInstanceCreateTime	String	2021-10-21T10:30:45Z	The time when the instance was created.
DBInstanceName	String	pxc-i-tk6t4z****	The instance name.
CharacterType	String	Node role	The node property. Valid values: polarx_cn: compute node polarx_store: data node polarx_gms: GMS node
MaintainStartTime	String	Not displayed	The start time of the O&M window.
DiskSize	Long	3145728	The disk size.
MaintainEndTime	String	Not displayed	The end time of the O&M window.
LockReason	String	Not displayed	The reason why the instance is locked.
DBInstanceStatus	Integer	8	The instance status.
LockMode	Integer	0	Indicates whether the instance is locked. Valid values: 0: unlocked 1: locked
EngineVersion	String	5.7	The database engine version. Default value: 2.0.
DBInstanceConnType	Integer	Not displayed	The connection type.
MaxConnections	Integer	4000	The maximum number of connections.
DBInstanceId	String	304726049	The instance ID.
Engine	String	mysql	The database engine version. Valid values: mysql polarx_cdc polarx_dn
MaxIops	Integer	7000	The maximum IOPS.
DBInstanceDescription	String	Not displayed	The instance description.
DBInstanceStatusDescription	String	Not displayed	The description of the instance status.
ConnectionIp	Array of ConnectionIp		The data structure.
Port	String	3306	The port.
DBInstanceNetType	Integer	1	The internal connection method. The value is fixed to 1, which indicates the classic network.
ConnectionString	String	pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com	The connection information.
Region	String	cn-hangzhou	The region where the node is located. If the node is an RDS node, the regions of its child nodes are separated by semicolons (;).
Azone	String	cn-hangzhou-a	The zone where the node is located. If the node is an RDS node, the zones of its child nodes are separated by semicolons (;).
Role	String	master	The role of the node. Valid values: master: primary node standby: secondary node
Activated	Boolean	true	Indicates whether the node is enabled. In the compute layer, only nodes in the primary zone are enabled. After a primary/secondary switchover, the secondary node becomes the primary node. All nodes in the storage layer are enabled.
AzoneRoleList	Array of aoneRoleMap		The list of data of the three nodes of an RDS instance.
Azone	String	cn-hangzhou-a	The zone where a node of the three-node RDS instance is located.
Role	String	leader	The role of a node in the three-node RDS instance. Valid values: leader: primary node follower: secondary node logger: change data capture (CDC) node
Status	String	0	The node status. Valid values: 0: running 1: creating 2: abnormal 3: expired 4: releasing 5: released 6: locked
NodeClass	String	polarx.x4.large.2e	The node specifications. Valid values: polarx.x4.medium.2e: 2 CPU cores, 8 GB of memory polarx.x4.large.2e: 4 CPU cores, 16 GB of memory polarx.x8.large.2e: 4 CPU cores, 32 GB of memory polarx.x4.xlarge.2e: 8 CPU cores, 32 GB of memory polarx.x8.xlarge.2e: 8 CPU cores, 64 GB of memory polarx.x4.2xlarge.2e: 16 CPU cores, 64 GB of memory polarx.x8.2xlarge.2e: 16 CPU cores, 128 GB of memory polarx.x4.4xlarge.2e: 32 CPU cores, 128 GB of memory polarx.x8.4xlarge.2e: 32 CPU cores, 256 GB of memory polarx.st.8xlarge.2e: 60 CPU cores, 470 GB of memory polarx.st.12xlarge.2e: 90 CPU cores, 720 GB of memory
Version	String	polarx-cdc-kernel-2.0.0-3985896	The version of the change data capture (CDC) node.
PhyInstanceName	String	pxc-unrbk8oyz**********	The physical instance name.
StorageUsed	String	16681	The used storage space. Unit: MB.
HistoryItems	Array of historyItems		The list of historical nodes.
CharacterType	String	Node role	The node property. Valid values: polarx_cn: compute node polarx_store: data node polarx_gms: GMS node
Role	String	master	The role of the node. Valid values: master: primary node standby: secondary node
DBInstanceName	String	pxc-sprcym7g7w****	The instance name.
DBInstanceId	String	304726049	The instance ID.
Region	String	cn-hangzhou	The region where the node is located. If the node is an RDS node, the regions of its child nodes are separated by semicolons (;).
Azone	String	cn-hangzhou-a	The zone where the node is located. If the node is an RDS node, the zones of its child nodes are separated by semicolons (;).
Activated	Boolean	true	Indicates whether the node is enabled. In the compute layer, only nodes in the primary zone are enabled. After a primary/secondary switchover, the secondary node becomes the primary node. All nodes in the storage layer are enabled.
PhyInstanceName	String	pxc-unrbk8oyz**********	The physical instance name.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDBInstanceTopology
&RegionId=cn-hangzhou
&DBInstanceName=pxc-********
&StartTime=2021-10-21T10:30:45Z 04:00:00
&EndTime=2021-10-22T10:30:45Z 04:00:00
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstanceTopologyResponse>
    <RequestId>C458B1E8-1683-3645-B154-6BA32080EEA</RequestId>
    <Data>
        <LogicInstanceTopology>
            <DBInstanceName>pxc-sprcym7g7w****</DBInstanceName>
            <DBInstanceCreateTime>2021-10-21T10:30:45Z 04:00:00</DBInstanceCreateTime>
            <MaintainStartTime>04:00:00</MaintainStartTime>
            <MaintainEndTime>05:00:00</MaintainEndTime>
            <LockReason>OverduePayments</LockReason>
            <DBInstanceStatus>8</DBInstanceStatus>
            <LockMode>0</LockMode>
            <EngineVersion>2.0</EngineVersion>
            <DBInstanceStorage>1</DBInstanceStorage>
            <DBInstanceConnType>lvs</DBInstanceConnType>
            <DBInstanceId>304726047</DBInstanceId>
            <Engine>polarx</Engine>
            <DBInstanceDescription>pxc-sprcym7******</DBInstanceDescription>
            <DBInstanceStatusDescription>TDE_MODIFYING</DBInstanceStatusDescription>
            <Items>
                <DBInstanceCreateTime>2021-10-21T10:30:45Z</DBInstanceCreateTime>
                <DBInstanceName>pxc-i-tk6t4z****</DBInstanceName>
                <CharacterType>Node role</CharacterType>
                <MaintainStartTime>N/A</MaintainStartTime>
                <DiskSize>3145728</DiskSize>
                <MaintainEndTime>N/A</MaintainEndTime>
                <LockReason>N/A</LockReason>
                <DBInstanceStatus>8</DBInstanceStatus>
                <LockMode>0</LockMode>
                <EngineVersion>5.7</EngineVersion>
                <MaxConnections>4000</MaxConnections>
                <DBInstanceId>304726049</DBInstanceId>
                <Engine>mysql</Engine>
                <MaxIops>7000</MaxIops>
                <DBInstanceDescription>N/A</DBInstanceDescription>
                <DBInstanceStatusDescription>N/A</DBInstanceStatusDescription>
                <ConnectionIp>
                    <Port>3306</Port>
                    <DBInstanceNetType>1</DBInstanceNetType>
                    <ConnectionString>pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com</ConnectionString>
                </ConnectionIp>
                <Region>cn-hangzhou</Region>
                <Azone>cn-hangzhou-a</Azone>
                <Role>master</Role>
                <Activated>true</Activated>
                <AzoneRoleList>
                    <Azone>cn-hangzhou-a</Azone>
                    <Role>leader</Role>
                </AzoneRoleList>
                <Status>0</Status>
                <NodeClass>polarx.x4.large.2e</NodeClass>
                <Version>polarx-cdc-kernel-2.0.0-3985896</Version>
                <PhyInstanceName>pxc-unrbk8oyz**********</PhyInstanceName>
            </Items>
            <HistoryItems>
                <CharacterType>Node role</CharacterType>
                <Role>master</Role>
                <DBInstanceName>pxc-sprcym7g7w****</DBInstanceName>
                <DBInstanceId>304726049</DBInstanceId>
                <Region>cn-hangzhou</Region>
                <Azone>cn-hangzhou-a</Azone>
                <Activated>true</Activated>
                <PhyInstanceName>pxc-unrbk8oyz**********</PhyInstanceName>
            </HistoryItems>
        </LogicInstanceTopology>
    </Data>
</DescribeDBInstanceTopologyResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Data" : {
    "LogicInstanceTopology" : {
      "DBInstanceName" : "pxc-sprcym7g7w****",
      "DBInstanceCreateTime" : "2021-10-21T10:30:45Z 04:00:00",
      "MaintainStartTime" : "04:00:00",
      "MaintainEndTime" : "05:00:00",
      "LockReason" : "OverduePayments",
      "DBInstanceStatus" : 8,
      "LockMode" : 0,
      "EngineVersion" : "2.0",
      "DBInstanceStorage" : 1,
      "DBInstanceConnType" : "lvs",
      "DBInstanceId" : "304726047",
      "Engine" : "polarx",
      "DBInstanceDescription" : "pxc-sprcym7******",
      "DBInstanceStatusDescription" : "TDE_MODIFYING",
      "Items" : [ {
        "DBInstanceCreateTime" : "2021-10-21T10:30:45Z",
        "DBInstanceName" : "pxc-i-tk6t4z****",
        "CharacterType" : "Node role",
        "MaintainStartTime" : "N/A",
        "DiskSize" : 3145728,
        "MaintainEndTime" : "N/A",
        "LockReason" : "N/A",
        "DBInstanceStatus" : 8,
        "LockMode" : 0,
        "EngineVersion" : "5.7",
        "MaxConnections" : 4000,
        "DBInstanceId" : "304726049",
        "Engine" : "mysql",
        "MaxIops" : 7000,
        "DBInstanceDescription" : "N/A",
        "DBInstanceStatusDescription" : "N/A",
        "ConnectionIp" : [ {
          "Port" : "3306",
          "DBInstanceNetType" : 1,
          "ConnectionString" : "pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com"
        } ],
        "Region" : "cn-hangzhou",
        "Azone" : "cn-hangzhou-a",
        "Role" : "master",
        "Activated" : true,
        "AzoneRoleList" : [ {
          "Azone" : "cn-hangzhou-a",
          "Role" : "leader"
        } ],
        "Status" : "0",
        "NodeClass" : "polarx.x4.large.2e",
        "Version" : "polarx-cdc-kernel-2.0.0-3985896",
        "PhyInstanceName" : "pxc-unrbk8oyz**********"
      } ],
      "HistoryItems" : [ {
        "CharacterType" : "Node role",
        "Role" : "master",
        "DBInstanceName" : "pxc-sprcym7g7w****",
        "DBInstanceId" : "304726049",
        "Region" : "cn-hangzhou",
        "Azone" : "cn-hangzhou-a",
        "Activated" : true,
        "PhyInstanceName" : "pxc-unrbk8oyz**********"
      } ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBInstance.NotFound	The specified DB instance does not exist.	The specified PolarDB-X instance does not exist.

For more information about other error codes, see Error codes.