DescribeBackupPolicy - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Operation description

Note

Data backup is supported for ApsaraDB for ClickHouse clusters running version 20.3, 20.8, or 21.8.

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:DescribeBackupPolicy

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	cc-bp1qx68m06981****

Response elements

Element	Type	Description	Example
	object
PreferredBackupPeriod	string	The backup cycle. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday	Monday
Switch	string	Indicates whether the backup feature is enabled. Valid values: true: The backup feature is enabled. false: The backup feature is disabled.	true
RequestId	string	The request ID.	F5178C10-1407-4987-9133-DE4DC9119F75
PreferredBackupTime	string	The backup time in UTC.	15:00Z-16:00Z
BackupRetentionPeriod	integer	The backup retention period. Default value: 7. Valid values: 7 to 730. Unit: day.	7
BackupSize	string	The backup size. Unit: MB.	123124

Examples

Success response

JSON format

{
  "PreferredBackupPeriod": "Monday",
  "Switch": "true",
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "BackupRetentionPeriod": 7,
  "BackupSize": "123124"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.