API参考—实例管理—DescribeDBInstances

本文涉及的产品
云原生数据库 PolarDB 分布式版,标准版 2核8GB
简介: 调用DescribeDBInstances接口查看实例列表详情。

调试

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

调试

请求参数

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

系统规定参数。取值为DescribeDBInstances

RegionId String ch-hangzhou

实例所属地域。

PageNumber Integer 1

页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1

PageSize Integer 30

每页记录数,取值为3050100

默认值为30

ResourceGroupId String -1

资源组ID。

返回数据

名称 类型 示例值 描述
DBInstances Array of DBInstance

实例信息。

ExpireDate String 2020-08-29T06:09:30.000+0800

实例到期时间,格式为yyyy-MM-ddTHH:mm:ss.SSSZ,例如2020-08-29T06:09:30.000+0800表示该实例于北京时间(UTC+8)2020年8月29日上午6时9分30秒到期。

说明 仅包年包月实例支持该参数。

PageNumber Integer 1

页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1

PageSize Integer 30

每页记录数,取值为3050100

默认值为30

RequestId String 91EA81C3-1622-47BF-BDCC-0D7BA1******

请求ID。

示例

请求示例


http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeDBInstances
&RegionId=ch-hangzhou
&<公共请求参数>

正常返回示例

XML 格式


<code>200</code>

<data>
<RequestId>91EA81C3-1622-47BF-BDCC-0D7BA1</RequestId>
<PageSize>2</PageSize>
<PageNumber>1</PageNumber>
<DBInstances>
<Status>Running</Status>
<Description/>
<ZoneId>cn-hangzhou-h</ZoneId>
<NodeCount>2</NodeCount>
<VPCId>vpc-*</VPCId>
<CreateTime>2020-07-29T06:09:30.000+0800</CreateTime>
<Expired>false</Expired>
<PayType>Prepaid</PayType>
<DBType>polarx</DBType>
<LockMode>Unlock</LockMode>
<StorageUsed>6784286720</StorageUsed>
<NodeClass>polarx.x4.large.2d</NodeClass>
<DBVersion>5.7</DBVersion>
<Network>VPC</Network>
<CommodityCode>drds_polarxpre_public_cn</CommodityCode>
<Id>pxc-**</Id>
<RegionId>cn-hangzhou</RegionId>
<ExpireTime>2020-08-29T06:09:30.000+0800</ExpireTime>
<Engine>polarx</Engine>
</DBInstances>
<DBInstances>
<Status>Running</Status>
<Description>2test</Description>
<ZoneId>cn-hangzhou-h</ZoneId>
<NodeCount>2</NodeCount>
<VPCId>vpc-*</VPCId>
<CreateTime>2020-07-29T06:09:30.000+0800</CreateTime>
<Expired>false</Expired>
<PayType>Prepaid</PayType>
<DBType>polarx</DBType>
<LockMode>Unlock</LockMode>
<StorageUsed>6834618368</StorageUsed>
<NodeClass>polarx.x4.large.2d</NodeClass>
<DBVersion>5.7</DBVersion>
<Network>VPC</Network>
<CommodityCode>drds_polarxpre_public_cn</CommodityCode>
<Id>pxc-**</Id>
<RegionId>cn-hangzhou</RegionId>
<ExpireTime>2020-08-29T06:09:30.000+0800</ExpireTime>
<Engine>polarx</Engine>
</DBInstances>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>91EA81C3-1622-47BF-BDCC-0D7BA1</requestId>
<successResponse>true</successResponse>

JSON 格式


{
"code": "200",
"data": {
"RequestId": "91EA81C3-1622-47BF-BDCC-0D7BA1",
"PageSize": 2,
"PageNumber": 1,
"DBInstances": [{
"Status": "Running",
"Description": "",
"ZoneId": "cn-hangzhou-h",
"NodeCount": 2,
"VPCId": "vpc-*",
"CreateTime": "2020-07-29T06:09:30.000+0800",
"Expired": false,
"PayType": "Prepaid",
"DBType": "polarx",
"LockMode": "Unlock",
"StorageUsed": 6784286720,
"NodeClass": "polarx.x4.large.2d",
"DBVersion": "5.7",
"Network": "VPC",
"CommodityCode": "drds_polarxpre_public_cn",
"Id": "pxc-**",
"RegionId": "cn-hangzhou",
"ExpireTime": "2020-08-29T06:09:30.000+0800",
"Engine": "polarx"
}, {
"Status": "Running",
"Description": "2test",
"ZoneId": "cn-hangzhou-h",
"NodeCount": 2,
"VPCId": "vpc-*",
"CreateTime": "2020-07-29T06:09:30.000+0800",
"Expired": false,
"PayType": "Prepaid",
"DBType": "polarx",
"LockMode": "Unlock",
"StorageUsed": 6834618368,
"NodeClass": "polarx.x4.large.2d",
"DBVersion": "5.7",
"Network": "VPC",
"CommodityCode": "drds_polarxpre_public_cn",
"Id": "pxc-**",
"RegionId": "cn-hangzhou",
"ExpireTime": "2020-08-29T06:09:30.000+0800",
"Engine": "polarx"
}]
},
"httpStatusCode": "200",
"requestId": "91EA81C3-1622-47BF-BDCC-0D7BA1",
"successResponse": true
}
            </div>
相关实践学习
快速体验PolarDB开源数据库
本实验环境已内置PostgreSQL数据库以及PolarDB开源数据库:PolarDB PostgreSQL版和PolarDB分布式版,支持一键拉起使用,方便各位开发者学习使用。
相关文章
|
监控 前端开发 Java
错误码如何设计才合理?
对于错误码的设计,不同的开发团队有不同的风格习惯。本文分享阿里文娱技术专家长统对于错误码的看法,希望从错误码使用的不同场景讨论得到一个合理的错误码规约,得到一个面向日志错误码标准和一个面向外部传递的错误码标准。
10432 3
错误码如何设计才合理?
|
XML JSON API
API参考—实例管理—RestartDBInstance
调用RestartDBInstance接口重启实例。
|
JSON API 开发工具
API参考—实例管理—CreateDBInstance
API参考—实例管理—CreateDBInstance
152 0
|
XML JSON API
API参考—实例管理—DeleteDBInstance
调用DeleteDBInstance接口释放实例。
|
XML JSON API
API参考—实例管理—ModifyDBInstanceDescription
调用ModifyDBInstanceDescription接口修改实例描述。
|
XML JSON API
API参考—实例管理—DescribeDBInstances
调用DescribeDBInstances接口查看实例列表详情。
|
6月前
|
XML SQL JSON
query 与 params:选择正确的参数传递方式
query 与 params:选择正确的参数传递方式
|
XML JSON API
API参考—实例管理—ModifyDBInstanceMaintainTime
调用ModifyDBInstanceMaintainTime接口修改实例可维护时间。
|
XML JSON API
API参考—实例管理—DescribeDBInstanceAttribute
调用DescribeDBInstanceAttribute接口查看实例的详细信息。
|
监控 前端开发 数据库
应用错误码设计规范
提供错误码的设计规范建议
1463 0