DescribeDBInstances - PolarDB

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 of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDBInstances	The operation that you want to perform. Set the value to DescribeDBInstances.
RegionId	String	Yes	cn-hangzhou	The region ID of the instances.
PageNumber	Integer	No	1	The page number. Pages start from page 1.
PageSize	Integer	No	20	The number of entries per page. Valid values: 5 to 1000.
ResourceGroupId	String	No	rg-acfmyst47******	The resource group ID.
Tags	String	No	[{\"TagKey\":\"test\",\"TagValue\":\"test-value\"}]	The tags.
InstanceId	String	No	dinga93c84f4d***	The instance ID.
Series	String	No	enterprise	The instance edition. Valid values: enterprise: Enterprise Edition standard: Standard Edition
MustHasCdc	Boolean	No	true	Specifies whether Log Engine is required.

Response parameters

Parameter	Type	Example	Description
RequestId	String	C458B1E8-1683-3645-B154-6BA32080EEA	The request ID.
PageNumber	Integer	1	The page number.
PageSize	Integer	30	The number of entries per page.
TotalNumber	Integer	30	The total number of entries.
DBInstances	Array of DBInstance		The queried instances.
Type	String	ReadWrite	The instance role. Valid values: ReadWrite: primary instance ReadOnly: read-only instance
Status	String	Running	The instance status. For more information, see Instance status table.
CommodityCode	String	drds_polarxpre_public_cn	The commodity code of the instance.
ExpireTime	String	2021-12-01T16:00:00.000+0000	The expiration time of the instance.
Expired	Boolean	false	Indicates whether the instance has expired.
CreateTime	String	2021-11-01T03:49:50.000+0000	The time when the instance was created.
PayType	String	Prepaid	The billing method of the instance. Valid values: Postpaid: pay-as-you-go Prepaid: subscription
LockReason	String	OverduePayments	The reason why the instance was locked.
DBType	String	polarx	The database engine type.
LockMode	String	Unlock	Indicates whether the instance is locked.
VPCId	String	VPCID	The ID of the virtual private cloud (VPC) to which the instance belongs.
MinorVersion	String	polarx-kernel_5.4.12-16349923_xcluster-20210926	The minor engine version of the instance.
RegionId	String	cn-hangzhou	The region ID of the instance.
Network	String	VPC	The network type of the instance.
DBVersion	String	5.7	The version of the database engine.
Description	String	Test	The description of the database.
NodeClass	String	polarx.x4.large.2e	The node type.
StorageUsed	Long	40658534400	The storage space that is used.
NodeCount	Integer	5	The number of nodes in the instance.
ZoneId	String	cn-hangzhou-g	The zone ID of the instance.
Engine	String	polarx	The engine type.
Id	String	pxc-hzr2yeov******	The instance ID.
Nodes	Array of PolarDBXNode		The information about the nodes.
ZoneId	String	cn-hangzhou-g	The zone ID.
Id	String	pxi-zd89wrzqh******	The node ID.
ClassCode	String	polarx.x4.large.2e	The node type.
RegionId	String	cn-hangzhou-g-aliyun	The region ID of the node.
ReadDBInstances	Array of String	pxr-hzr2yeov******	The names of read-only instances.
ColumnarReadDBInstances	Array of String	xxxxxxxx	The information about columnar read-only instances.
ResourceGroupId	String	rg-xxxxxx	The resource group ID.
TagSet	Array of TagSet		The information about the tags.
Key	String	key1	The key of the tag.
Value	String	value1	The value of the tag.
DBInstanceName	String	pxc-xxxxx	The instance name.
DnNodeCount	Integer	2	The number of data nodes in the instance.
CnNodeCount	Integer	2	The number of compute nodes in the instance.
CnNodeClassCode	String	polarx.x4.large.2e	The compute node type. Valid values: polarx.x4.medium.2e: 2 CPU cores and 8 GB of memory polarx.x4.large.2e: 4 CPU cores and 16 GB of memory polarx.x8.large.2e: 4 CPU cores and 32 GB of memory polarx.x4.xlarge.2e: 8 CPU cores and 32 GB of memory polarx.x8.xlarge.2e: 8 CPU cores and 64 GB of memory polarx.x4.2xlarge.2e: 16 CPU cores and 64 GB of memory polarx.x8.2xlarge.2e: 16 CPU cores and 128 GB of memory polarx.x4.4xlarge.2e: 32 CPU cores and 128 GB of memory polarx.x8.4xlarge.2e: 32 CPU cores and 256 GB of memory polarx.st.8xlarge.2e: 60 CPU cores and 470 GB of memory polarx.st.12xlarge.2e: 90 CPU cores and 720 GB of memory
DnNodeClassCode	String	mysql.n4.medium.25	The data node type. Valid values: mysql.n2.medium.25: 2 CPU cores and 4 GB of memory mysql.n4.medium.25: 2 CPU cores and 8 GB of memory mysql.x8.medium.25: 2 CPU cores and 16 GB of memory mysql.n2.large.25: 4 CPU cores and 8 GB of memory mysql.n4.large.25: 4 CPU cores and 16 GB of memory mysql.x8.large.25: 4 CPU cores and 32 GB of memory mysql.n2.xlarge.25: 8 CPU cores and 16 GB of memory mysql.n4.xlarge.25: 8 CPU cores and 32 GB of memory mysql.x8.xlarge.25: 8 CPU cores and 64 GB of memory mysql.n4.2xlarge.25: 16 CPU cores and 64 GB of memory mysql.x8.2xlarge.25: 16 CPU cores and 128 GB of memory mysql.x4.4xlarge.25: 32 CPU cores and 128 GB of memory mysql.x8.4xlarge.25: 32 CPU cores and 256 GB of memory mysql.st.8xlarge.25: 60 CPU cores and 470 GB of memory mysql.st.12xlarge.25: 90 CPU cores and 720 GB of memory
Series	String	enterprise	The instance edition. Valid values: enterprise: Enterprise Edition standard: Standard Edition
ContainBinlogX	Boolean	true	Indicates whether multi-stream binary logs are included. Valid values: true false
SupportBinlogX	Boolean	true	Indicates whether multi-stream binary logs are supported on the instance. Valid values: true false
CdcInstanceName	String	pxc-c-dmlgit****	The name of the change data capture (CDC) node.
TopologyType	String	3azones	The topology type of the instance. Valid values: 3azones: three-zone topology 1azone: singe-zone topology
TertiaryZone	String	cn-hangzhou-k	The tertiary zone.
PrimaryZone	String	cn-hangzhou-j	The primary zone.
SecondaryZone	String	cn-hangzhou-l	The secondary zone.
ColumnarInstanceName	String	xxxxxxxx	The name of the columnar read-only instance.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=20
&ResourceGroupId=rg-acfmyst47******
&Tags=[{\"TagKey\":\"test\",\"TagValue\":\"test-value\"}]
&InstanceId=dinga93c84f4d***
&Series=enterprise
&MustHasCdc=true
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDBInstancesResponse>
    <RequestId>C458B1E8-1683-3645-B154-6BA32080EEA</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>30</PageSize>
    <TotalNumber>30</TotalNumber>
    <DBInstances>
        <Type>ReadWrite</Type>
        <Status>Running</Status>
        <CommodityCode>drds_polarxpre_public_cn</CommodityCode>
        <ExpireTime>2021-12-01T16:00:00.000+0000</ExpireTime>
        <Expired>false</Expired>
        <CreateTime>2021-11-01T03:49:50.000+0000</CreateTime>
        <PayType>Prepaid</PayType>
        <LockReason>OverduePayments</LockReason>
        <DBType>polarx</DBType>
        <LockMode>Unlock</LockMode>
        <VPCId>VPCID</VPCId>
        <MinorVersion>polarx-kernel_5.4.12-16349923_xcluster-20210926</MinorVersion>
        <RegionId>cn-hangzhou</RegionId>
        <Network>VPC</Network>
        <DBVersion>5.7</DBVersion>
        <Description>Test</Description>
        <NodeClass>polarx.x4.large.2e</NodeClass>
        <StorageUsed>40658534400</StorageUsed>
        <NodeCount>5</NodeCount>
        <ZoneId>cn-hangzhou-g</ZoneId>
        <Engine>polarx</Engine>
        <Id>pxc-hzr2yeov******</Id>
        <Nodes>
            <ZoneId>cn-hangzhou-g</ZoneId>
            <Id>pxi-zd89wrzqh******</Id>
            <ClassCode>polarx.x4.large.2e</ClassCode>
            <RegionId>cn-hangzhou-g-aliyun</RegionId>
        </Nodes>
        <ReadDBInstances>pxr-hzr2yeov******</ReadDBInstances>
        <ResourceGroupId>rg-xxxxxx</ResourceGroupId>
        <TagSet>
            <Key>key1</Key>
            <Value>value1</Value>
        </TagSet>
        <DBInstanceName>pxc-xxxxx</DBInstanceName>
        <DnNodeCount>2</DnNodeCount>
        <CnNodeCount>2</CnNodeCount>
        <CnNodeClassCode>polarx.x4.large.2e</CnNodeClassCode>
        <DnNodeClassCode>mysql.n4.medium.25</DnNodeClassCode>
        <Series>enterprise</Series>
        <ContainBinlogX>true</ContainBinlogX>
        <SupportBinlogX>true</SupportBinlogX>
        <CdcInstanceName>pxc-c-dmlgit****</CdcInstanceName>
        <TopologyType>3azones</TopologyType>
        <TertiaryZone>cn-hangzhou-k</TertiaryZone>
        <PrimaryZone>cn-hangzhou-j</PrimaryZone>
        <SecondaryZone>cn-hangzhou-l</SecondaryZone>
        <ColumnarInstanceName>xxxxx</ColumnarInstanceName>
    </DBInstances>
</DescribeDBInstancesResponse>

JSON format

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

{
  "RequestId" : "C458B1E8-1683-3645-B154-6BA32080EEA",
  "PageNumber" : 1,
  "PageSize" : 30,
  "TotalNumber" : 30,
  "DBInstances" : [ {
    "Type" : "ReadWrite",
    "Status" : "Running",
    "CommodityCode" : "drds_polarxpre_public_cn",
    "ExpireTime" : "2021-12-01T16:00:00.000+0000",
    "Expired" : false,
    "CreateTime" : "2021-11-01T03:49:50.000+0000",
    "PayType" : "Prepaid",
    "LockReason": "OverduePayments",
    "DBType" : "polarx",
    "LockMode" : "Unlock",
    "VPCId" : "VPCID",
    "MinorVersion" : "polarx-kernel_5.4.12-16349923_xcluster-20210926",
    "RegionId" : "cn-hangzhou",
    "Network" : "VPC",
    "DBVersion" : "5.7",
    "Description": "Test",
    "NodeClass" : "polarx.x4.large.2e",
    "StorageUsed" : 40658534400,
    "NodeCount" : 5,
    "ZoneId" : "cn-hangzhou-g",
    "Engine" : "polarx",
    "Id" : "pxc-hzr2yeov******",
    "Nodes" : [ {
      "ZoneId" : "cn-hangzhou-g",
      "Id" : "pxi-zd89wrzqh******",
      "ClassCode" : "polarx.x4.large.2e",
      "RegionId" : "cn-hangzhou-g-aliyun"
    } ],
    "ReadDBInstances" : [ "pxr-hzr2yeov******" ],
    "ColumnarReadDBInstances" : [ ],
    "ResourceGroupId" : "rg-xxxxxx",
    "TagSet" : [ {
      "Key" : "key1",
      "Value" : "value1"
    } ],
    "DBInstanceName" : "pxc-xxxxx",
    "DnNodeCount" : 2,
    "CnNodeCount" : 2,
    "CnNodeClassCode" : "polarx.x4.large.2e",
    "DnNodeClassCode" : "mysql.n4.medium.25",
    "Series" : "enterprise",
    "ContainBinlogX" : true,
    "SupportBinlogX" : true,
    "CdcInstanceName" : "pxc-c-dmlgit****",
    "TopologyType" : "3azones",
    "TertiaryZone" : "cn-hangzhou-k",
    "PrimaryZone" : "cn-hangzhou-j",
    "SecondaryZone" : "cn-hangzhou-l",
    "ColumnarInstanceName" : "xxxxx"
  } ]
}

Error codes

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