All Products
Search
Document Center

PolarDB:ModifyAutoRenewAttribute

Last Updated:Nov 07, 2023

Modifies the auto-renewal attributes of a subscription PolarDB cluster.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:ModifyAutoRenewAttributeWRITE
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdsstringYes

The cluster ID. If you need to specify multiple cluster IDs, separate the cluster IDs with commas (,).

pc-***************
RegionIdstringYes

The ID of the region. The region ID can be up to 50 characters in length. cn-hangzhou

Note You can call the DescribeRegions operation to query the available regions.
cn-hangzhou
RenewalStatusstringNo

The auto-renewal state of the cluster. Valid values:

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

Default value: AutoRenewal.

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

The automatic renewal period.

  • Valid values when PeriodUnit is set to Month: 1, 2, 3, 6, and 12.
  • Valid values when PeriodUnit is set to Year: 1, 2, and 3.

Default value: 1.

1
PeriodUnitstringNo

The unit of the renewal period. Valid values:

  • Year
  • Month

Default value: Month.

Month
ResourceGroupIdstringNo

The ID of the resource group.

rg-************

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

4CE6DF97-AEA4-484F-906F-C407EE******

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-12The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Error Codes 404 change
    Added Error Codes: 400
    Added Error Codes: 403