All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeBackupPolicy

Last Updated:Nov 12, 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

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
clickhouse:DescribeBackupPolicyget
  • All Resources
    *
    none
none

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