DescribeAutoRenewAttribute - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries the auto-renewal status of a ClickHouse Community-Compatible cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

clickhouse:DescribeAutoRenewAttribute

get

*DBCluster

acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-beijing
DBClusterIds	string	No	The cluster ID.	cc-uf6g4417bo*****
PageSize	integer	No	The number of entries per page.	30
PageNumber	integer	No	The page number.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D0CEC6AC-7760-409A-A0D5-E*******
PageNumber	integer	The page number.	1
PageRecordCount	integer	The number of entries on the current page.	5
TotalRecordCount	integer	The total number of entries.	51
Items	object
AutoRenewAttribute	array<object>	The auto-renewal information.
	object
DBClusterId	string	The cluster ID.	cc-2ze57pg09*****
PeriodUnit	string	The subscription duration unit. Valid values: Month and Year.	Year
Duration	integer	The subscription duration.	1
RenewalStatus	string	The renewal status. Valid values: AutoRenewal: The cluster is automatically renewed. Normal: The cluster is manually renewed. NotRenewal: The cluster is not renewed upon expiration.	AutoRenewal
AutoRenewEnabled	boolean	Indicates whether auto-renewal is enabled. Valid values: true: Enabled. false: Disabled.
RegionId	string	The region ID.	cn-beijing

Examples

Success response

JSON format

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E*******",
  "PageNumber": 1,
  "PageRecordCount": 5,
  "TotalRecordCount": 51,
  "Items": {
    "AutoRenewAttribute": [
      {
        "DBClusterId": "cc-2ze57pg09*****",
        "PeriodUnit": "Year",
        "Duration": 1,
        "RenewalStatus": "AutoRenewal",
        "AutoRenewEnabled": true,
        "RegionId": "cn-beijing"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.