All Products
Search
Document Center

ApsaraDB for ClickHouse:CreateBackupPolicy

Last Updated:Jan 03, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

cc-bp108z124a8o7****
PreferredBackupTimestringYes

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
PreferredBackupPeriodstringYes

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
BackupRetentionPeriodstringNo

The retention period for the backup data. By default, the backup data is retained for seven days. Valid values: 7 to 730. Unit: day.

8
RegionIdstringNo

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

F5178C10-1407-4987-9133-DE4DC9119F75

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe 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 timeSummary of changesOperation
No change history