调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | DescribeDBInstances | 系统规定参数。取值为DescribeDBInstances。 |
RegionId | String | 是 | ch-hangzhou | 实例所属地域。 |
PageNumber | Integer | 否 | 1 | 页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1。 |
PageSize | Integer | 否 | 30 |
每页记录数,取值为30、50或100。 默认值为30。 |
ResourceGroupId | String | 否 | -1 | 资源组ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
DBInstances | Array of DBInstance | 实例信息。 |
|
ExpireDate | String | 2020-08-29T06:09:30.000+0800 |
实例到期时间,格式为
说明 仅包年包月实例支持该参数。 |
PageNumber | Integer | 1 | 页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1。 |
PageSize | Integer | 30 |
每页记录数,取值为30、50或100。 默认值为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 }