DescribeBackups-阿里云帮助中心

Queries the backup sets of a ClickHouse Enterprise Edition cluster.

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

none

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The cluster ID.	cc-bp1v9kq45u0o80cvh
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the region ID.	cn-beijing
BackupId	string	No	The backup record ID.	117403****
StartTime	string	Yes	The beginning of the time range to query. The time is in UTC.	2021-11-21T16:00Z
EndTime	string	Yes	The end of the time range to query. The time is in UTC.	2021-11-25T16:00Z
PageSize	integer	No	The number of entries to return on each page.	30
PageNumber	integer	No	The page number.	1

Response elements

Element	Type	Description	Example
	object	The response.
TotalCount	string	The total number of backups.	1
PageSize	string	The number of entries returned per page.	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	The list of backup sets.
DBInstanceId	string	The cluster ID.	cc-bp179i5956tih2m93
BackupStatus	string	The status of the backup set.	Success
BackupType	string	The backup type. Valid values: FullBackup: full backup. IncrementalBackup: incremental backup.	IncrementalBackup
BackupStartTime	string	The start time of the backup.	2021-11-22T18:28:22Z
BackupSize	integer	The size of the backup file in MB.	131072
BackupEndTime	string	The end time of the backup. The time is in UTC.	2021-11-22T18:28:41Z
BackupSetInfo	string	The information about the backup set.	{"shard_count": 4}
BackupId	string	The backup record ID.	117403****
BackupMethod	string	The backup method.	Physical
ExpireDate	string	The expiration time of the backup set.	2022-07-22T18:28:41Z

Examples

Success response

JSON format

{
  "TotalCount": "1",
  "PageSize": "30",
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber": "1",
  "Items": [
    {
      "DBInstanceId": "cc-bp179i5956tih2m93",
      "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

See for a complete list.

Release notes

See Release Notes for a complete list.