DescribeAutoRenewalAttribute - 查询包年包月集群自动续费状态

更新时间:
复制为 MD 格式

查询包年包月集群自动续费状态。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
DBClusterIdarray

集群 ID 列表。

string

集群 ID。

am-bp1u8c0mgfg58****
PageSizeinteger

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
PageNumberinteger

页码,取值为大于 0 且不超过 Integer 数据类型最大值的正整数。默认值为 1

1
ResourceGroupIdstring

资源组 ID。

rg-4690g37929****

返回参数

名称类型描述示例值
object
TotalRecordCountinteger

总记录数。

20
PageRecordCountinteger

每页记录数。

30
RequestIdstring

请求 ID。

BA0F6761-7A8C-59F8-9624-FB56788C0EDF
PageNumberinteger

页码。

1
Itemsarray<object>

自动续费详情列表。

AutoRenewalAttributeobject
DBClusterIdstring

集群 ID。

amv-uf6485635fz8****
AutoRenewalPeriodUnitstring

自动续费时长的单位,取值说明:

  • Year:年。
  • Month:月。
Year
AutoRenewalPeriodlong

自动续费时长。

1
AutoRenewalStatusstring

自动续费状态,取值说明:

  • AutoRenewal:自动续费。
  • Normal:手动续费,集群到期前通过短信提醒。
  • NotRenewal:到期不续费,集群到期前无提醒,只在到期前第三天发送不续费提醒。
AutoRenewal
AutoRenewalEnabledboolean

是否开启自动续费,取值说明:

  • true:开启。
  • false:关闭。
true
RegionIdstring

地域 ID。

cn-shenzhen

示例

正常返回示例

JSON格式

{
  "TotalRecordCount": 20,
  "PageRecordCount": 30,
  "RequestId": "BA0F6761-7A8C-59F8-9624-FB56788C0EDF",
  "PageNumber": 1,
  "Items": {
    "AutoRenewalAttribute": [
      {
        "DBClusterId": "amv-uf6485635fz8****",
        "AutoRenewalPeriodUnit": "Year",
        "AutoRenewalPeriod": 1,
        "AutoRenewalStatus": "AutoRenewal",
        "AutoRenewalEnabled": true,
        "RegionId": "cn-shenzhen"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-12-16新增 OpenAPI查看变更详情