You can call this operation to set the auto-renewal attribute for a specified subscription ApsaraDB for PolarDB cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
DBClusterIds String Yes pc-xxxxxxxxxxxxxxxx

The ID of the ApsaraDB for PolarDB cluster.

RegionId String Yes cn-hangzhou

The ID of the region. It can be up to 50 characters in length.

Note You can call the DescribeRegions operation to query the most recent region list.
AccessKeyId String No key-test

The AccessKey ID provided to you by Alibaba Cloud.

Action String No ModifyAutoRenewAttribute

The operation that you want to perform. Set the value to ModifyAutoRenewAttribute.

Duration String No 1

Specifies the automatic renewal period.

  • When the PeriodUnit parameter is set to Month, the value of this parameter is [1,2,3,6,12].
  • When the PeriodUnit parameter is set to Year, the value of this parameter is [1-3].

    Default value: 1

PeriodUnit String No Month

The unit of the renewal period. Valid values:

  • Year
  • Month

    Default value: Month

RenewalStatus String No AutoRenewal

Specifies the auto-renewal status of the cluster. Valid values:

  • AutoRenewal: The cluster is automatically renewed.
  • Normal: The cluster is manually renewed.
  • NotRenewal: The cluster is not renewed.

Default value: AutoRenewal

Note If this parameter is set to NotRenewal, the system does not send a reminder for expiration, but only sends a reminder three days before the cluster expires to remind you that the cluster is not renewed.

Response parameters

Parameter Type Example Description
RequestId String 4CE6DF97-AEA4-484F-906F-C407EE3770EB

The ID of the request.

Examples

Sample requests


http(s)://polardb.aliyuncs.com/? Action=ModifyAutoRenewAttribute
&DBClusterIds=pc-xxxxxxxxxxxxxxxx
&RegionId=cn-hangzhou
&RenewalStatus=Normal
&<Common request parameters>

Sample success responses

XML format

<ModifyAutoRenewAttributeResponse>  
	  <RequestId>4CE6DF97-AEA4-484F-906F-C407EE3770EB</RequestId>
</ModifyAutoRenewAttributeResponse>

JSON format

{
	"RequestId":"4CE6DF97-AEA4-484F-906F-C407EE3770EB"
}

Error codes

For a list of error codes, visit the API Error Center.