All Products
Search

This Product

    ApsaraDB for ClickHouse:DescribeBackups

    Document Center

    ApsaraDB for ClickHouse:DescribeBackups

    Last Updated:Oct 28, 2025

    Queries the backup sets of a specified ApsaraDB for ClickHouse cluster.

    Operation description

    Note

    The data backup feature is available only on ApsaraDB for ClickHouse clusters running version 21.8 or later.

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

    get

    *DBCluster

    acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

    cc-bp1qx68m06981****
    BackupId

    string

    No

    The data backup task ID.

    117403****
    StartTime

    string

    Yes

    The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

    2021-11-21T16:00Z
    EndTime

    string

    Yes

    The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

    2021-11-25T16:00Z
    PageSize

    integer

    No

    The number of entries per page. Valid values:

    • 30 (default)

    • 50

    • 100

    30
    PageNumber

    integer

    No

    The page number.

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    string

    The total number of entries.

    1
    PageSize

    string

    The number of entries per page. Valid values:

    • 30 (default)

    • 50

    • 100

    30
    RequestId

    string

    The request ID.

    F5178C10-1407-4987-9133-DE4DC9119F75
    PageNumber

    string

    The page number.

    1
    Items

    array<object>

    The list of backup sets.

    object

    DBClusterId

    string

    The cluster ID.

    cc-bp1qx68m06981****
    BackupStatus

    string

    The backup status. Valid values:

    • Success: The backup is successful.

    • Failure: The backup failed.

    Success
    BackupType

    string

    The backup type. Valid values:

    • FullBackup: full backup.

    • IncrementalBackup: incremental backup.

    IncrementalBackup
    BackupStartTime

    string

    The start time of the backup. The time is in the yyyy-MM-ddTHH:mmZ format and is displayed in UTC.

    2021-11-22T18:28:22Z
    BackupSize

    integer

    The backup size. Unit: MB.

    131072
    BackupEndTime

    string

    The end time of the backup. The time is in the yyyy-MM-ddTHH:mmZ format and is displayed in UTC.

    2021-11-22T18:28:41Z
    BackupSetInfo

    string

    The number of cluster nodes.

    • For a single-replica edition cluster, the value is an integer from 1 to 48.

    • For a double-replica edition cluster, the value is an integer from 1 to 24.

    {"shard_count": 4}
    BackupId

    string

    The data backup task ID.

    117403****
    BackupMethod

    string

    The backup method. The value is always Physical, which indicates a physical backup.

    Physical
    ExpireDate

    string

    The expiration time of the backup set. The time is in the yyyy-MM-ddTHH:mmZ format and is displayed in UTC.

    2022-07-22T18:28:41Z

    Examples

    Success response

    JSON format

    {
  "TotalCount": "1",
  "PageSize": "30",
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber": "1",
  "Items": [
    {
      "DBClusterId": "cc-bp1qx68m06981****",
      "BackupStatus": "Success",
      "BackupType": "IncrementalBackup",
      "BackupStartTime": "2021-11-22T18:28:22Z",
      "BackupSize": 131072,
      "BackupEndTime": "2021-11-22T18:28:41Z",
      "BackupSetInfo": "{\"shard_count\": 4}",
      "BackupId": "117403****",
      "BackupMethod": "Physical",
      "ExpireDate": "2022-07-22T18:28:41Z"
    }
  ]
}

    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.