调用DescribeDBInstances接口查询实例列表_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDBInstances	系统规定参数。取值：DescribeDBInstances。
RegionId	String	是	cn-hangzhou	实例所属地域ID。
PageNumber	Integer	否	1	分页下标：从1开始。
PageSize	Integer	否	20	页面大小，取值范围为：5~1000。
ResourceGroupId	String	否	rg-acfmyst47******	资源组ID。
Tags	String	否	[{\"TagKey\":\"test\",\"TagValue\":\"test-value\"}]	标签列表。
InstanceId	String	否	dinga93c84f4d***	实例ID。
Series	String	否	enterprise	实例系列，取值如下： enterprise：企业版 standard：标准版
MustHasCdc	Boolean	否	true	是否必须有日志引擎。

返回数据

名称	类型	示例值	描述
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-hzr2yeov******	实例ID。
Nodes	Array of PolarDBXNode		节点列表。
ZoneId	String	cn-hangzhou-g	可用区ID。
Id	String	pxi-zd89wrzqh******	节点ID。
ClassCode	String	polarx.x4.large.2e	实例规格。
RegionId	String	cn-hangzhou-g-aliyun	区域ID。
ReadDBInstances	Array of String	pxr-hzr2yeov******	只读实例名称。
ColumnarReadDBInstances	Array of String	xxxxxxxx	列存只读实例信息。
ResourceGroupId	String	rg-xxxxxx	资源组ID
TagSet	Array of TagSet		标签集合。
Key	String	key1	标签名称。
Value	String	value1	标签值。
DBInstanceName	String	pxc-xxxxx	数据库实例名称。
DnNodeCount	Integer	2	DN节点个数。
CnNodeCount	Integer	2	CN节点个数。
CnNodeClassCode	String	polarx.x4.large.2e	CN节点规格。 polarx.x4.medium.2e：2核8G polarx.x4.large.2e：4核16G polarx.x8.large.2e：4核32G polarx.x4.xlarge.2e：8核32G polarx.x8.xlarge.2e：8核64G polarx.x4.2xlarge.2e：16核64G polarx.x8.2xlarge.2e：16核128G polarx.x4.4xlarge.2e：32核128G polarx.x8.4xlarge.2e：32核256G polarx.st.8xlarge.2e：60核470G polarx.st.12xlarge.2e：90核720G
DnNodeClassCode	String	mysql.n4.medium.25	DN节点规格。 mysql.n2.medium.25：2核4G mysql.n4.medium.25：2核8G mysql.x8.medium.25：2核16G mysql.n2.large.25：4核8G mysql.n4.large.25：4核16G mysql.x8.large.25：4核32G mysql.n2.xlarge.25：8核16G mysql.n4.xlarge.25：8核32G mysql.x8.xlarge.25：8核64G mysql.n4.2xlarge.25：16核64G mysql.x8.2xlarge.25：16核128G mysql.x4.4xlarge.25：32核128G mysql.x8.4xlarge.25：32核256G mysql.st.8xlarge.25：60核470G mysql.st.12xlarge.25：90核720G
Series	String	enterprise	实例系列，取值如下： enterprise：企业版 standard：标准版
ContainBinlogX	Boolean	true	是否包含多流日志服务，取值如下： true：是 false：否
SupportBinlogX	Boolean	true	当前实例是否支持多流，取值如下： true：是 false：否
CdcInstanceName	String	pxc-c-dmlgit****	日志节点名称。
TopologyType	String	3azones	拓扑类型： 3azones：三可用区； 1azone：单可用区。
TertiaryZone	String	cn-hangzhou-k	第三可用区。
PrimaryZone	String	cn-hangzhou-j	主可用区。
SecondaryZone	String	cn-hangzhou-l	次可用区。
ColumnarInstanceName	String	xxxxxxxx	列存引擎实例名称。

示例

请求示例

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
&公共请求参数

正常返回示例

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-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格式

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-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"
  } ]
}

错误码

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