通过过期时间查询实例信息 - 云数据库 RDS

说明该接口仅适用于包年包月的RDS实例。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDBInstancesByExpireTime	系统规定参数。取值：DescribeDBInstancesByExpireTime。
RegionId	String	否	cn-hangzhou	地域ID。可调用DescribeRegions获取。
proxyId	String	否	无	废弃参数。
ExpirePeriod	Integer	否	180	实例剩余可用天数。取值：0~180。
Expired	Boolean	否	True	实例的过期状态，取值： True：已过期 False：未过期
PageSize	Integer	否	30	每页记录数，取值：1~100。默认值：30。
PageNumber	Integer	否	1	页码，取值：大于0且不超过Integer类型的最大值。默认值：1。
Tags	String	否	{"key1":"value1"}	查询绑定有该标签的实例，包括TagKey和TagValue。单次最多支持传入5组值，格式：`{"key1":"value1","key2":"value2"...}`。

返回数据


名称	类型	示例值	描述
RequestId	String	1AD222E9-E606-4A42-BF6D-8A4442913CEF	请求ID。
PageNumber	Integer	1	页码，取值：大于0且不超过Integer类型的最大值。默认值：1。
PageRecordCount	Integer	2	当前页的实例个数。
TotalRecordCount	Integer	200	总记录数。
Items	Array of DBInstanceExpireTime		由实例信息组成的数组。
DBInstanceExpireTime
ExpireTime	String	2019-03-27T16:00:00Z	实例到期时间。yyyy-MM-ddTHH:mm:ssZ（UTC时间）。说明按量付费实例无到期时间。
PayType	String	Prepaid	实例付费方式。取值： Postpaid：按量付费 Prepaid：包年包月
DBInstanceId	String	rm-uf6wjk5xxxxxxx	实例ID。
DBInstanceStatus	String	Running	实例状态。详情请参见实例状态表。
DBInstanceDescription	String	测试数据库	实例备注。
LockMode	String	Unlock	实例锁定模式。取值： Unlock：正常 ManualLock：手动触发锁定 LockByExpiration：实例过期自动锁定 LockByRestoration：实例回滚前的自动锁定 LockByDiskQuota：实例空间满自动锁定 LockReadInstanceByDiskQuota：只读实例空间满自动锁定

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstancesByExpireTime
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstancesByExpireTimeResponse>
    <TotalRecordCount>200</TotalRecordCount>
    <PageRecordCount>2</PageRecordCount>
    <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
    <PageNumber>1</PageNumber>
    <Items>
        <DBInstanceExpireTime>
            <DBInstanceStatus>Running</DBInstanceStatus>
            <DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
            <PayType>Prepaid</PayType>
            <LockMode>Unlock</LockMode>
            <ExpireTime>2019-03-27T16:00:00Z</ExpireTime>
            <DBInstanceDescription>测试数据库</DBInstanceDescription>
        </DBInstanceExpireTime>
    </Items>
</DescribeDBInstancesByExpireTimeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : "200",
  "PageRecordCount" : "2",
  "RequestId" : "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber" : "1",
  "Items" : {
    "DBInstanceExpireTime" : [ {
      "DBInstanceStatus" : "Running",
      "DBInstanceId" : "rm-uf6wjk5xxxxxxx",
      "PayType" : "Prepaid",
      "LockMode" : "Unlock",
      "ExpireTime" : "2019-03-27T16:00:00Z",
      "DBInstanceDescription" : "测试数据库"
    } ]
  }
}

错误码

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