全部产品
Search
文档中心

云数据库 RDS:DescribeDBInstancesByExpireTime - 按过期时间获取数据库实例

更新时间:Mar 13, 2024

该接口用于通过包年包月实例的剩余可用时间查询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:DescribeDBInstancesByExpireTimeRead
  • 全部资源
    *
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。可调用 DescribeRegions 获取。

cn-hangzhou
proxyIdstring

废弃参数,无需配置。

API
ExpirePeriodinteger

实例剩余可用天数。取值:0~180

180
Expiredboolean

实例的过期状态,取值:

  • True:已过期
  • False:未过期
True
PageSizeinteger

每页记录数,取值:1~100

默认值:30

30
PageNumberinteger

页码,取值:大于 0 且不超过 Integer 类型的最大值。

默认值:1

1
Tagsstring

查询绑定有该标签的实例,包括 TagKey 和 TagValue。单次最多支持传入 5 组值,格式:{"key1":"value1","key2":"value2"...}

{"key1":"value1"}
ResourceGroupIdstring

资源组 ID。可调用 DescribeDBInstanceAttribute 获取。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumberinteger

页码,取值:大于 0 且不超过 Integer 类型的最大值。

默认值:1

1
PageRecordCountinteger

当前页的实例个数。

2
TotalRecordCountinteger

总记录数。

200
Itemsobject []

实例信息列表。

ExpireTimestring

实例到期时间。yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

说明 按量付费实例无到期时间。
2019-03-27T16:00:00Z
PayTypestring

实例付费方式。取值:

  • Postpaid:按量付费
  • Prepaid:包年包月
Prepaid
DBInstanceIdstring

实例 ID。

rm-uf6wjk5xxxxxxx
DBInstanceStatusstring

实例状态。详情请参见实例状态表

Running
DBInstanceDescriptionstring

实例备注。

testInstance
LockModestring

实例锁定模式。取值:

  • Unlock:正常
  • ManualLock:手动触发锁定
  • LockByExpiration:实例过期自动锁定
  • LockByRestoration:实例回滚前的自动锁定
  • LockByDiskQuota:实例空间满自动锁定
  • LockReadInstanceByDiskQuota:只读实例空间满自动锁定
Unlock

示例

正常返回示例

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

错误码

HTTP status code错误码错误信息描述
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。

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

变更历史

变更时间变更内容概要操作
2023-07-25OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId