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

调试

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

请求参数

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

系统规定参数,取值:DescribeAutoRenewAttribute

RegionId String cn-hangzhou

地域ID,长度不超过50个字符,通过接口DescribeRegions查看可用的地域。

DBClusterIds String pc-xxxxxxxxxxxxxxxx

集群ID。多个集群用英文逗号“,”分隔。

PageSize Integer 30

每页记录数,取值:30、50、100。

默认值:30。

PageNumber Integer 1

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

ResourceGroupId String rg-rexxxxxxxxxx

资源组ID。

返回数据

名称 类型 示例值 描述
Items Array

集群续费信息列表。

AutoRenewAttribute
AutoRenewEnabled Boolean true

是否开启自动续费:

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

集群ID。

Duration Integer 1

续费时长。

PeriodUnit String Month

时长单位:

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

地域ID。

RenewalStatus String AutoRenewal

续费状态,取值:

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

页数。

PageRecordCount Integer 1

总页数。

RequestId String 8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D

请求ID。

TotalRecordCount Integer 1

总记录数。

示例

请求示例

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

正常返回示例

XML 格式

<DescribeAutoRenewAttributeResponse>  
	  <Items>
		    <AutoRenewAttribute>
			      <RenewalStatus>Normal</RenewalStatus>
			      <Duration>1</Duration>
			      <RegionId>cn-hangzhou</RegionId>
			      <AutoRenewEnabled>true</AutoRenewEnabled>
			      <PeriodUnit>Month</PeriodUnit>
			      <DBClusterId>pc-xxxxxxxxxxxxxxxx</DBClusterId>
		    </AutoRenewAttribute>
	  </Items>
	  <TotalRecordCount>1</TotalRecordCount>
	  <PageNumber>1</PageNumber>
	  <RequestId>8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D</RequestId>
	  <PageRecordCount>1</PageRecordCount>
</DescribeAutoRenewAttributeResponse>

JSON 格式

{
	"Items": {
		"AutoRenewAttribute": [
			{
				"RenewalStatus": "AutoRenewal",
				"Duration": 1,
				"RegionId": "cn-hangzhou",
				"AutoRenewEnabled": true,
				"PeriodUnit": "Month",
				"DBClusterId": "pc-xxxxxxxxxxxxxxxx"
			}
		]
	},
	"TotalRecordCount": 1,
	"PageNumber": 1,
	"RequestId": "8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D",
	"PageRecordCount": 1
}

错误码

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