调用DescribeDBInstances接口查询实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBInstances

系统规定参数。取值:DescribeDBInstances

RegionId String cn-hangzhou

实例所属地域ID。

PageNumber Integer 1

分页下标:从1开始。

PageSize Integer 20

页面大小。

返回数据

名称 类型 示例值 描述
RequestId String C458B1E8-1683-3645-B154-6BA32080EEA

请求ID。

PageNumber Integer 1

页面下标。

PageSize Integer 30

页面大小。

TotalNumber Integer 30

总数。

DBInstances Array of DBInstance

实例列表。

Type String ReadWrite

实例类型:

  • ReadWrite: 主实例
  • ReadOnly: 只读实例
Status String Running

实例状态,详情请参见实例状态表

CommodityCode String drds_polarxpre_public_cn

商品类型。

ExpireTime String 2021-12-01T16:00:00.000+0000

过期时间。

Expired Boolean false

是否过期。

CreateTime String 2021-11-01T03:49:50.000+0000

创建时间。

PayType String Prepaid

实例付费方式,取值:

  • Postpaid:按量付费;
  • Prepaid:包年包月。
LockReason String 欠费

锁定原因。

DBType String polarx

数据库类型。

LockMode String Unlock

是否锁定。

VPCId String VPCID

VPC ID。

MinorVersion String polarx-kernel_5.4.12-16349923_xcluster-20210926

当前内核版本。

RegionId String cn-hangzhou

地域ID。

Network String VPC

网络类型。

DBVersion String 5.7

数据库版本。

Description String 测试

数据库描述。

NodeClass String polarx.x4.large.2e

规格。

StorageUsed Long 40658534400

存储使用。

NodeCount Integer 5

节点个数。

ZoneId String cn-hangzhou-g

可用区ID。

Engine String polarx

引擎型号。

Id String pxc-hzr2yeov9jmg3z

实例ID。

Nodes Array of PolarDBXNode

节点列表。

ZoneId String cn-hangzhou-g

可用区ID。

Id String pxi-zd89wrzqhbfwyuo"

节点ID。

ClassCode String polarx.x4.large.2e

实例规格。

RegionId String cn-hangzhou-g-aliyun

区域ID。

ReadDBInstances Array of String pxr-hzr2yeov9jmg3z

只读实例名称。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=20
&公共请求参数

正常返回示例

XML格式

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>欠费</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>测试</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格式

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" : "欠费",
    "DBType" : "polarx",
    "LockMode" : "Unlock",
    "VPCId" : "VPCID",
    "MinorVersion" : "polarx-kernel_5.4.12-16349923_xcluster-20210926",
    "RegionId" : "cn-hangzhou",
    "Network" : "VPC",
    "DBVersion" : "5.7",
    "Description" : "测试",
    "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" ]
  } ]
}

错误码

访问错误中心查看更多错误码。