All Products
Search

This Product

    PolarDB:ModifyAutoRenewAttribute

    Document Center

    PolarDB:ModifyAutoRenewAttribute

    Last Updated:Jun 17, 2024

    Modifies the auto-renewal attributes of a subscription PolarDB 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
    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 status of the cluster. Valid values:

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

    Default value: AutoRenewal.

    Note If you set this parameter to NotRenewal, the system sends a notification that indicates the cluster is not renewed three days before the cluster expires. After the cluster expires, the system no longer sends a notification.
    		AutoRenewal
    DurationstringNo

    The automatic renewal period.

    • Valid values when you set the PeriodUnit parameter to Month: 1, 2, 3, 6, and 12.
    • Valid values when you set the PeriodUnit parameter 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
    400InvalidRenewalStatus.MalformedThe specified parameter RenewalStatus is not valid.The specified RenewalStatus parameter is invalid.
    400InvalidPeriodUnit.MalformedThe specified parameter PeriodUnit is not valid.The specified PeriodUnit parameter is invalid.
    400InvalidDuration.MalformedThe specified parameter Duration is not valid.The specified Duration parameter is invalid.
    403OperationDenied.DBClusterPayTypeThe operation is not permitted due to the pay type of cluster.This operation is not supported by the billing method of the cluster.
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.

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

    Change history

    Change timeSummary of changesOperation
    2023-09-12The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 404 change
      Added Error Codes: 400
      Added Error Codes: 403