CreateBackupPolicy - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Creates a backup policy.

Operation description

Note This operation is available only for the ApsaraDB for ClickHouse clusters of versions 20.3, 20.8, and 21.8.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
clickhouse:CreateBackupPolicy	create	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	cc-bp108z124a8o7****
PreferredBackupTime	string	Yes	The backup window. Specify the time in the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time must be in Coordinated Universal Time (UTC). For example, if you set the backup window to 00:00Z-01:00Z, the data of the cluster can be backed up from 08:00 (UTC+8) to 09:00 (UTC+8).	10:00Z-11:00Z
PreferredBackupPeriod	string	Yes	The day of a week when the system regularly backs up data. If you specify multiple days of a week, separate them with commas (,). Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday	Monday,Friday
BackupRetentionPeriod	string	No	The backup retention period. The default retention period is seven days. Valid values: 7 to 730. Unit: days.	8
RegionId	string	No	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	F5178C10-1407-4987-9133-DE4DC9119F75

Examples

Sample success responses

JSONformat

{
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75"
}

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.

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

Change history

Change time	Summary of changes	Operation
2024-09-26	API Description Update. The Error code has changed	View Change Details