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

调试

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

请求参数

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

系统规定参数,取值:DescribeAutoRenewAttribute

RegionId String cn-hangzhou

地域ID。

说明 您可以通过接口 DescribeRegions查看地域ID详情。
DBClusterIds String pc-****************

集群ID,支持传入多个集群ID,多个集群ID间用英文逗号(,)分隔。

PageSize Integer 30

每页记录数,取值范围为30、50、100,默认值为30。

PageNumber Integer 1

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

ResourceGroupId String rg-re*********

资源组ID。

返回数据

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

集群续费信息列表。

AutoRenewAttribute
AutoRenewEnabled Boolean true

是否开启自动续费:

  • true:开启。
  • false:关闭。
DBClusterId String pc-*****************

集群ID。

Duration Integer 4

续费时长。

PeriodUnit String Month

时长单位:

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

地域ID。

RenewalStatus String AutoRenewal

续费状态,取值范围如下:

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

页数。

PageRecordCount Integer 1

总页数。

RequestId String 65D7ACE6-4A61-4B6E-B357-8CB24A******

请求ID。

TotalRecordCount Integer 1

总记录数。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeAutoRenewAttribute
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<DescribeAutoRenewAttributeResponse>
  <TotalRecordCount>1</TotalRecordCount>
  <PageRecordCount>1</PageRecordCount>
  <RequestId>65D7ACE6-4A61-4B6E-B357-8CB24A******</RequestId>
  <PageNumber>1</PageNumber>
  <Items>
        <AutoRenewAttribute>
              <AutoRenewEnabled>true</AutoRenewEnabled>
              <DBClusterId>pc-*****************</DBClusterId>
              <RenewalStatus>AutoRenewal</RenewalStatus>
              <Duration>4</Duration>
              <RegionId>cn-hangzhou</RegionId>
              <PeriodUnit>Month</PeriodUnit>
        </AutoRenewAttribute>
  </Items>
</DescribeAutoRenewAttributeResponse>

JSON 格式

{
	"TotalRecordCount": 1,
	"PageRecordCount": 1,
	"RequestId": "65D7ACE6-4A61-4B6E-B357-8CB24A******",
	"PageNumber": 1,
	"Items": {
		"AutoRenewAttribute": [
			{
				"AutoRenewEnabled": true,
				"DBClusterId": "pc-*****************",
				"RenewalStatus": "AutoRenewal",
				"Duration": 4,
				"RegionId": "cn-hangzhou",
				"PeriodUnit": "Month"
			}
		]
	}
}

错误码

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