All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeBackupPolicy

Last Updated:Jul 17, 2024

Queries the backup settings of an ApsaraDB for ClickHouse cluster.

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

cc-bp1qx68m06981****

Response parameters

ParameterTypeDescriptionExample
object
PreferredBackupPeriodstring

The day of a week when the system regularly backs up data. Valid values:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
Monday
Switchstring

Indicates whether the backup feature is enabled. Valid values:

  • true
  • false
true
RequestIdstring

The request ID.

F5178C10-1407-4987-9133-DE4DC9119F75
PreferredBackupTimestring

The backup window. The time is displayed in Coordinated Universal Time (UTC).

15:00Z-16:00Z
BackupRetentionPeriodinteger

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

7
BackupSizestring

The size of the backup data. Unit: MB.

123124

Examples

Sample success responses

JSONformat

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

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
2022-06-07The Error code has changed. The response structure of the API has changedView Change Details