文档

DescribeInstanceAutoRenewalAttribute - 查询实例是否开通自动续费

更新时间:

查看Redis实例是否开通自动续费。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeInstanceAutoRenewalAttributeRead
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/*
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

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

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

ETnLKlblzczshOTUbOCz****
RegionIdstring

实例所属的地域 ID。

cn-hangzhou
DBInstanceIdstring

实例的 ID。

说明 默认查询所有实例是否开通自动续费。
r-bp1zxszhcgatnx****
PageSizeinteger

每页记录数,取值:3050100

说明 默认值:30
30
PageNumberinteger

页码,大于 0 且不超过 Integer 的最大值,默认值:1

1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

2B17D708-1D6D-49F3-B6D7-478371DD****
PageNumberinteger

当前显示的页码。

1
PageRecordCountinteger

当前页显示的记录数。

30
TotalRecordCountinteger

总记录数。

1
Itemsobject []

实例的自动续费信息组成的集合。

Durationinteger

续费周期,单位为月。

1
DBInstanceIdstring

实例 ID。

r-bp1zxszhcgatnx****
AutoRenewstring

自动续费状态,返回值:

  • true:已开启。
  • false:未开启。
true
RegionIdstring

地域 ID。

cn-shanghai

示例

正常返回示例

JSON格式

{
  "RequestId": "2B17D708-1D6D-49F3-B6D7-478371DD****",
  "PageNumber": 1,
  "PageRecordCount": 30,
  "TotalRecordCount": 1,
  "Items": {
    "Item": [
      {
        "Duration": 1,
        "DBInstanceId": "r-bp1zxszhcgatnx****",
        "AutoRenew": "true",
        "RegionId": "cn-shanghai"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400IllegalParameterSpecified parameter exceeds range.

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