DescribeDBInstances - API Reference| Alibaba Cloud Documentation Center

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 ID of the region.
PageNumber	Integer	No	1	The number of the page to return. Pages start from page 1.
PageSize	Integer	No	20	The number of entries to return on each page.

Response parameters


Parameter	Type	Example	Description
RequestId	String	C458B1E8-1683-3645-B154-6BA32080EEA	The ID of the request.
PageNumber	Integer	1	The page number of the returned page.
PageSize	Integer	30	The number of entries returned per page.
TotalNumber	Integer	30	The total number of returned instances.
DBInstances	Array of DBInstance		The details about the returned instances.
Type	String	ReadWrite	The role of the instance. Valid values: ReadWrite: The instance is a primary instance. ReadOnly: The instance is a read-only instance.
Status	String	Running	The state of the instance. For more information, see Instance states.
CommodityCode	String	drds_polarxpre_public_cn	The commodity code of the instance.
ExpireTime	String	2021-12-01T16:00:00.000+0000	The time when the instance expires.
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 is locked.
DBType	String	polarx	The database type of the instance.
LockMode	String	Unlock	Indicates whether the instance is locked.
VPCId	String	VPCID	The ID of the virtual private cloud (VPC) to which the instance is connected.
MinorVersion	String	polarx-kernel_5.4.12-16349923_xcluster-20210926	The minor kernel 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 that is used by the instance.
Description	String	Testing	The description of the instance.
NodeClass	String	polarx.x4.large.2e	The instance type of each node for the instance.
StorageUsed	Long	40658534400	The storage space that has been used.
NodeCount	Integer	5	The number of nodes.
ZoneId	String	cn-hangzhou-g	The zone ID of the instance.
Engine	String	polarx	The engine that is used by the instance.
Id	String	pxc-hzr2yeov9jmg3z	The ID of the instance.
Nodes	Array of PolarDBXNode		The details about nodes.
ZoneId	String	cn-hangzhou-g	The zone ID of the node.
Id	String	pxi-zd89wrzqhbfwyuo"	The ID of the node.
ClassCode	String	polarx.x4.large.2e	The instance type of the node.
RegionId	String	cn-hangzhou-g-aliyun	The region ID of the node.
ReadDBInstances	Array of String	pxr-hzr2yeov9jmg3z	The names of read-only instances.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=20&<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>Testing</Description>
        <NodeClass>polarx.x4.large.2e</NodeClass>
        <StorageUsed>40658534400</StorageUsed>
        <NodeCount>5</NodeCount>
        <ZoneId>cn-hangzhou-g</ZoneId>
        <Engine>polarx</Engine>
        <Id>pxc-hzr2yeov9jmg3z</Id>
        <Nodes>
            <ZoneId>cn-hangzhou-g</ZoneId>
            <Id>pxi-zd89wrzqhbfwyuo"</Id>
            <ClassCode>polarx.x4.large.2e</ClassCode>
            <RegionId>cn-hangzhou-g-aliyun</RegionId>
        </Nodes>
        <ReadDBInstances>pxr-hzr2yeov9jmg3z</ReadDBInstances>
    </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" : "Testing",
    "NodeClass" : "polarx.x4.large.2e",
    "StorageUsed" : 40658534400,
    "NodeCount" : 5,
    "ZoneId" : "cn-hangzhou-g",
    "Engine" : "polarx",
    "Id" : "pxc-hzr2yeov9jmg3z",
    "Nodes" : [ {
      "ZoneId" : "cn-hangzhou-g",
      "Id" : "pxi-zd89wrzqhbfwyuo\"",
      "ClassCode" : "polarx.x4.large.2e",
      "RegionId" : "cn-hangzhou-g-aliyun"
    } ],
    "ReadDBInstances" : [ "pxr-hzr2yeov9jmg3z" ]
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.