DescribeBackups - - Alibaba Cloud Documentation Center

Queries the backup sets of an ApsaraDB for ClickHouse cluster.

Note This operation is available only for ApsaraDB for ClickHouse clusters in version 21.8 and later.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeBackups	The operation that you want to perform. Set the value to DescribeBackups.
DBClusterId	String	Yes	cc-bp1qx68m06981****	The cluster ID.
BackupId	String	No	117403****	The ID of the backup task.
StartTime	String	Yes	2021-11-21T16:00Z	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in Coordinated Universal Time (UTC).
EndTime	String	Yes	2021-11-25T16:00Z	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.
PageSize	Integer	No	30	The number of entries to return on each page. Valid values: 30 (default) 50 100
PageNumber	Integer	No	1	The number of the page to return.

Response parameters


Parameter	Type	Example	Description
TotalCount	String	1	The total number of entries returned.
PageSize	String	30	The number of entries returned per page. Valid values: 30 (default) 50 100
RequestId	String	F5178C10-1407-4987-9133-DE4DC9119F75	The request ID.
PageNumber	String	1	The page number of the returned page.
Items	Array of Backup		The returned backup sets.
DBClusterId	String	cc-bp1qx68m06981****	The cluster ID.
BackupStatus	String	Success	The state of the backup task. Valid values: Success: The backup task was successful. Failure: The backup task failed.
BackupType	String	IncrementalBackup	The backup type. Valid values: FullBackup IncrementalBackup
BackupStartTime	String	2021-11-22T18:28:22Z	The start time of the backup task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.
BackupSize	Long	131072	The size of the backup set. Unit: MB.
BackupEndTime	String	2021-11-22T18:28:41Z	The end time of the backup task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.
BackupSetInfo	String	{"shard_count": 4}	The number of nodes in the cluster. If the cluster is of Single-replica Edition, the value ranges from 1 to 48. If the cluster is of Double-replica Edition, the value ranges from 1 to 24.
BackupId	String	117403****	The ID of the backup task.
BackupMethod	String	Physical	The backup method. Only Physical is returned. This value indicates that a physical backup is performed.
ExpireDate	String	2022-07-22T18:28:41Z	The time when the backup set expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

Examples

Sample requests

http(s)://clickhouse.aliyuncs.com/?Action=DescribeBackups
&DBClusterId=cc-bp1qx68m06981****
&StartTime=2021-11-21T16:00Z
&EndTime=2021-11-22T16:00Z
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 cluster ID does not exist. Check whether the value specified for the DBClusterId parameter is valid.

For a list of error codes, see Service error codes.