Modifies the auto-renewal attributes of a subscription PolarDB cluster.
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
polardb:ModifyAutoRenewAttribute | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBClusterIds | string | Yes | The cluster ID. If you need to specify multiple cluster IDs, separate the cluster IDs with commas (,). | pc-*************** |
RegionId | string | Yes | 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 |
RenewalStatus | string | No | The auto-renewal state of the cluster. Valid values:
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 |
Duration | string | No | The automatic renewal period.
Default value: 1. | 1 |
PeriodUnit | string | No | The unit of the renewal period. Valid values:
Default value: Month. | Month |
ResourceGroupId | string | No | The ID of the resource group. | rg-************ |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "4CE6DF97-AEA4-484F-906F-C407EE******"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
404 | InvalidDBCluster.NotFound | The 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 time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-09-12 | The Error code has changed | see changesets | ||||||||
|