该接口用于通过包年包月实例的剩余可用时间查询RDS实例信息。
接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
- RDS MariaDB
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:DescribeDBInstancesByExpireTime | READ |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域ID。可调用DescribeRegions获取。 | cn-hangzhou |
proxyId | string | 否 | 废弃参数,无需配置。 | API |
ExpirePeriod | integer | 否 | 实例剩余可用天数。取值:0~180。 | 180 |
Expired | boolean | 否 | 实例的过期状态,取值:
| True |
PageSize | integer | 否 | 每页记录数,取值:1~100。 默认值:30。 | 30 |
PageNumber | integer | 否 | 页码,取值:大于0且不超过Integer类型的最大值。 默认值:1。 | 1 |
Tags | string | 否 | 查询绑定有该标签的实例,包括TagKey和TagValue。单次最多支持传入5组值,格式: | {"key1":"value1"} |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"PageNumber": 1,
"PageRecordCount": 2,
"TotalRecordCount": 200,
"Items": {
"DBInstanceExpireTime": [
{
"ExpireTime": "2019-03-27T16:00:00Z",
"PayType": "Prepaid",
"DBInstanceId": "rm-uf6wjk5xxxxxxx",
"DBInstanceStatus": "Running",
"DBInstanceDescription": "testInstance",
"LockMode": "Unlock"
}
]
}
}
错误码
访问错误中心查看更多错误码。