调用DescribeAutoRenewAttribute接口查询包年包月集群自动续费状态。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAutoRenewAttribute

系统规定参数,取值:

DescribeAutoRenewAttribute。

RegionId String cn-hangzhou

地域ID。

DBClusterIds String am-bp1xxxxxxxx47

实例ID。

如果有多个实例ID,以英文逗号(,)分隔。

PageSize Integer 30

每页记录数,取值:

  • 30
  • 50
  • 100

默认值:30。

PageNumber Integer 1

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

默认值:1。

ResourceGroupId String rg-rexxxxxxxxxx

资源组ID。

返回数据

名称 类型 示例值 描述
Items Array of AutoRenewAttribute

集群续费信息列表。

AutoRenewAttribute
AutoRenewEnabled Boolean true

是否开启自动续费。

  • true:开启。
  • false:关闭。
DBClusterId String am-bp1xxxxxxxx47

实例ID。

Duration Integer 1

续费时长。

PeriodUnit String Year

续费时长单位。

  • Year:年。
  • Month:月。
RegionId String cn-hangzhou

地域ID。

RenewalStatus String AutoRenewal

续费状态。取值:

  • AutoRenewal:自动续费。
  • Normal:手动续费,实例到期前通过短信提醒。
  • NotRenewal:到期不续费,实例到期前无提醒,只在到期前第三天发送不续费提醒。
PageNumber Integer 1

页码。

PageRecordCount Integer 2

总页数。

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

请求ID。

TotalRecordCount Integer 20

总记录数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeAutoRenewAttribute
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<TotalRecordCount>20</TotalRecordCount>
<PageRecordCount>2</PageRecordCount>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<PageNumber>1</PageNumber>
<Items>
    <AutoRenewAttribute>
        <AutoRenewEnabled>true</AutoRenewEnabled>
        <DBClusterId>am-bp1xxxxxxxx47</DBClusterId>
        <RenewalStatus>AutoRenewal</RenewalStatus>
        <Duration>1</Duration>
        <RegionId>cn-hangzhou</RegionId>
        <PeriodUnit>Year</PeriodUnit>
    </AutoRenewAttribute>
</Items>

JSON 格式

{
    "TotalRecordCount":"20",
    "PageRecordCount":"2",
    "RequestId":"1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "PageNumber":"1",
    "Items":{
        "AutoRenewAttribute":[
            {
                "AutoRenewEnabled":"true",
                "DBClusterId":"am-bp1xxxxxxxx47",
                "RenewalStatus":"AutoRenewal",
                "Duration":"1",
                "RegionId":"cn-hangzhou",
                "PeriodUnit":"Year"
            }
        ]
    }
}

错误码

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