PolarDB:DescribeDBInstanceTopology

Request parameters

Response parameters

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

For a list of error codes, see Service error codes.