All Products
Search
Document Center

AnalyticDB:ModifyAutoRenewAttribute

Last Updated:Aug 30, 2024

Modifies the auto-renewal status of a subscription AnalyticDB for MySQL cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
adb:ModifyAutoRenewAttributeupdate
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.
am-bp1u389j9zjh5****
RegionIdstringYes

The region ID of the cluster.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
RenewalStatusstringNo

The 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.
AutoRenewal
DurationstringNo

The renewal duration. Default value: 1.

  • Valid values when PeriodUnit is set to Month: 1 to 11. Data type: INTEGER.
  • Valid values when PeriodUnit is set to Year: 1, 2, 3, and 5. Data type: INTEGER.
Note Longer subscription durations offer more savings. Purchasing a cluster for one year is more cost-effective than purchasing the cluster for 10 or 11 months.
1
PeriodUnitstringNo

The unit of the renewal period. Default value: Month. Valid values:

  • Year
  • Month
Year

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

4CE6DF97-AEA4-484F-906F-C407EE3770EB

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history