All Products
Search
Document Center

PolarDB:DescribeAutoRenewAttribute

Last Updated:Jun 17, 2024

Queries 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:DescribeAutoRenewAttributeRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

Note You can call the DescribeRegions operation to query the region ID details.
cn-hangzhou
DBClusterIdsstringNo

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

pc-****************
PageSizeintegerNo

The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.

30
PageNumberintegerNo

The page number. The value must be an integer that is larger than 0 and does not exceed the maximum value of the INTEGER data type. Default value: 1.

1
ResourceGroupIdstringNo

The ID of the resource group.

rg-re*********

Response parameters

ParameterTypeDescriptionExample
object
TotalRecordCountinteger

The total number of entries.

1
PageRecordCountinteger

The total number of pages returned.

1
RequestIdstring

The ID of the request.

65D7ACE6-4A61-4B6E-B357-8CB24A******
PageNumberinteger

The page number of the page returned.

1
Itemsobject []

The renewal information about the clusters.

DBClusterIdstring

The ID of the cluster.

pc-*****************
PeriodUnitstring

The unit of the duration. Valid values:

  • Year
  • Month
Month
Durationinteger

The renewal duration.

4
RenewalStatusstring

The renewal status. Valid values:

  • AutoRenewal: The cluster is automatically renewed.
  • Normal: The cluster is manually renewed. The system sends a text message to remind you before the cluster expires.
  • NotRenewal: The cluster is not renewed. The system does not send a reminder for expiration but only sends a text message three days before the cluster expires to remind you that the cluster is not renewed.
AutoRenewal
AutoRenewEnabledboolean

Indicates whether the auto-renewal feature is enabled. Valid values:

  • true: enabled
  • false: disabled
true
RegionIdstring

The ID of the region.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "RequestId": "65D7ACE6-4A61-4B6E-B357-8CB24A******",
  "PageNumber": 1,
  "Items": {
    "AutoRenewAttribute": [
      {
        "DBClusterId": "pc-*****************",
        "PeriodUnit": "Month",
        "Duration": 4,
        "RenewalStatus": "AutoRenewal",
        "AutoRenewEnabled": true,
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidRegionId.MalformedThe specified parameter RegionId is not valid.The specified RegionId parameter is invalid.
400InvalidPageSize.MalformedThe specified parameter PageSize is not valid.The specified PageSize parameter is invalid.
400InvalidPageNumber.MalformedThe specified parameter PageNumber is not valid.The specified PageNumber parameter is invalid.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.The request failed to be processed because unknown errors, exceptions, or failures have occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.A temporary server error occurred.

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

Change history

Change timeSummary of changesOperation
No change history