You can call this operation to query the list of backups in a cluster.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeBackups |
The operation that you want to perform. Set the value to DescribeBackups. |
BackupType | String | Yes | Incremental |
The type of the backup. Valid values:
|
ClusterId | String | Yes | cds-uf6m0bod****6158 |
The ID of the cluster for the backup. |
DataCenterId | String | Yes | cn-shanghai-e |
The ID of the data center for the backup in the cluster. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Backups | Array |
The list of backup tasks. |
|
Backup | |||
BackupId | String | 20200*** |
The ID of the backup. |
BackupType | String | Incremental |
The type of the backup. Valid values:
|
ClusterId | String | cds-uf6m0bod****6159 |
The ID of the cluster for the backup. |
DataCenterId | String | cn-shanghai-e |
The ID of the data center for the backup in the cluster. |
EndTime | String | 2020-02-26T02:12:50Z |
The end time of the backup task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC and denoted by Z. |
Size | Long | 149016650 |
The size of the backup. |
StartTime | String | 2020-02-26T01:57:00Z |
The start time of the backup task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC and denoted by Z. |
Status | String | Succeeded |
The state of the backup. Valid values:
|
RequestId | String | A6E59F3B-5CB7-4922-85CA-06EC0BB00BAA |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeBackups
&BackupType=Incremental
&ClusterId=cds-uf6m0bod****6158
&DataCenterId=cn-shanghai-e
&<Common request parameters>
Sample success responses
XML
format
<DescribeBackupsResponse>
<RequestId>A6E59F3B-5CB7-4922-85CA-06EC0BB00BAA</RequestId>
<Backups>
<Backup>
<Status>Succeeded</Status>
<DataCenterId>cn-shanghai-e</DataCenterId>
<EndTime>2020-02-26T02:12:50Z</EndTime>
<ClusterId>cds-uf6m0bo****6159</ClusterId>
<Size>149016650</Size>
<StartTime>2020-02-26T01:57:00Z</StartTime>
<BackupId>20200226</BackupId>
<BackupType>Incremental</BackupType>
</Backup>
<Backup>
<Status>Succeeded</Status>
<DataCenterId>cn-shanghai-e</DataCenterId>
<EndTime>2020-02-27T01:01:28Z</EndTime>
<ClusterId>cds-uf6m0bod****6159</ClusterId>
<Size>149494577</Size>
<StartTime>2020-02-27T01:01:00Z</StartTime>
<BackupId>20200227</BackupId>
<BackupType>Incremental</BackupType>
</Backup>
<Backup>
<Status>Succeeded</Status>
<DataCenterId>cn-shanghai-e</DataCenterId>
<EndTime>2020-02-28T01:01:23Z</EndTime>
<ClusterId>cds-uf6m0bo****v6159</ClusterId>
<Size>149282931</Size>
<StartTime>2020-02-28T01:01:00Z</StartTime>
<BackupId>20200228</BackupId>
<BackupType>Incremental</BackupType>
</Backup>
<Backup>
<Status>Succeeded</Status>
<DataCenterId>cn-shanghai-e</DataCenterId>
<EndTime>2020-02-29T01:00:56Z</EndTime>
<ClusterId>cds-uf6m0bod****6159</ClusterId>
<Size>149454625</Size>
<StartTime>2020-02-29T00:25:28Z</StartTime>
<BackupId>20200229</BackupId>
<BackupType>Incremental</BackupType>
</Backup>
<Backup>
<Status>Succeeded</Status>
<DataCenterId>cn-shanghai-e</DataCenterId>
<EndTime>2020-03-02T22:12:41Z</EndTime>
<ClusterId>cds-uf6m0bo****v6159</ClusterId>
<Size>149364202</Size>
<StartTime>2020-03-01T00:30:00Z</StartTime>
<BackupId>20200301</BackupId>
<BackupType>Incremental</BackupType>
</Backup>
<Backup>
<Status>Succeeded</Status>
<DataCenterId>cn-shanghai-e</DataCenterId>
<EndTime>2020-03-02T00:30:13Z</EndTime>
<ClusterId>cds-uf6m0bod****6159</ClusterId>
<Size>149356372</Size>
<StartTime>2020-03-02T00:30:00Z</StartTime>
<BackupId>20200302</BackupId>
<BackupType>Incremental</BackupType>
</Backup>
<Backup>
<Status>Succeeded</Status>
<DataCenterId>cn-shanghai-e</DataCenterId>
<EndTime>2020-03-04T02:11:59Z</EndTime>
<ClusterId>cds-uf6m0bo****v6159</ClusterId>
<Size>149359298</Size>
<StartTime>2020-03-03T00:30:00Z</StartTime>
<BackupId>20200303</BackupId>
<BackupType>Incremental</BackupType>
</Backup>
<Backup>
<Status>Succeeded</Status>
<DataCenterId>cn-shanghai-e</DataCenterId>
<EndTime>2020-03-04T02:12:09Z</EndTime>
<ClusterId>cds-uf6m0bod****6159</ClusterId>
<Size>149267899</Size>
<StartTime>2020-03-04T00:30:00Z</StartTime>
<BackupId>20200304</BackupId>
<BackupType>Incremental</BackupType>
</Backup>
<Backup>
<Status>Succeeded</Status>
<DataCenterId>cn-shanghai-e</DataCenterId>
<EndTime>2020-03-06T15:52:58Z</EndTime>
<ClusterId>cds-uf6m0bod****6159</ClusterId>
<Size>149188148</Size>
<StartTime>2020-03-05T00:30:00Z</StartTime>
<BackupId>20200305</BackupId>
<BackupType>Incremental</BackupType>
</Backup>
<Backup>
<Status>Succeeded</Status>
<DataCenterId>cn-shanghai-e</DataCenterId>
<EndTime>2020-03-06T15:53:06Z</EndTime>
<ClusterId>cds-uf6m0bod****6159</ClusterId>
<Size>149188280</Size>
<StartTime>2020-03-06T00:30:00Z</StartTime>
<BackupId>20200306</BackupId>
<BackupType>Incremental</BackupType>
</Backup>
</Backups>
</DescribeBackupsResponse>
JSON
format
{
"RequestId": "A6E59F3B-5CB7-4922-85CA-06EC0BB00BAA",
"Backups": {
"Backup": [
{
"Status": "Succeeded",
"DataCenterId": "cn-shanghai-e",
"EndTime": "2020-02-26T02:12:50Z",
"ClusterId": "cds-uf6m0bo****6159",
"Size": 149016650,
"StartTime": "2020-02-26T01:57:00Z",
"BackupId": "20200226",
"BackupType": "Incremental"
},
{
"Status": "Succeeded",
"DataCenterId": "cn-shanghai-e",
"EndTime": "2020-02-27T01:01:28Z",
"ClusterId": "cds-uf6m0bod****6159",
"Size": 149494577,
"StartTime": "2020-02-27T01:01:00Z",
"BackupId": "20200227",
"BackupType": "Incremental"
},
{
"Status": "Succeeded",
"DataCenterId": "cn-shanghai-e",
"EndTime": "2020-02-28T01:01:23Z",
"ClusterId": "cds-uf6m0bo****v6159",
"Size": 149282931,
"StartTime": "2020-02-28T01:01:00Z",
"BackupId": "20200228",
"BackupType": "Incremental"
},
{
"Status": "Succeeded",
"DataCenterId": "cn-shanghai-e",
"EndTime": "2020-02-29T01:00:56Z",
"ClusterId": "cds-uf6m0bod****6159",
"Size": 149454625,
"StartTime": "2020-02-29T00:25:28Z",
"BackupId": "20200229",
"BackupType": "Incremental"
},
{
"Status": "Succeeded",
"DataCenterId": "cn-shanghai-e",
"EndTime": "2020-03-02T22:12:41Z",
"ClusterId": "cds-uf6m0bo****v6159",
"Size": 149364202,
"StartTime": "2020-03-01T00:30:00Z",
"BackupId": "20200301",
"BackupType": "Incremental"
},
{
"Status": "Succeeded",
"DataCenterId": "cn-shanghai-e",
"EndTime": "2020-03-02T00:30:13Z",
"ClusterId": "cds-uf6m0bod****6159",
"Size": 149356372,
"StartTime": "2020-03-02T00:30:00Z",
"BackupId": "20200302",
"BackupType": "Incremental"
},
{
"Status": "Succeeded",
"DataCenterId": "cn-shanghai-e",
"EndTime": "2020-03-04T02:11:59Z",
"ClusterId": "cds-uf6m0bo****v6159",
"Size": 149359298,
"StartTime": "2020-03-03T00:30:00Z",
"BackupId": "20200303",
"BackupType": "Incremental"
},
{
"Status": "Succeeded",
"DataCenterId": "cn-shanghai-e",
"EndTime": "2020-03-04T02:12:09Z",
"ClusterId": "cds-uf6m0bod****6159",
"Size": 149267899,
"StartTime": "2020-03-04T00:30:00Z",
"BackupId": "20200304",
"BackupType": "Incremental"
},
{
"Status": "Succeeded",
"DataCenterId": "cn-shanghai-e",
"EndTime": "2020-03-06T15:52:58Z",
"ClusterId": "cds-uf6m0bod****6159",
"Size": 149188148,
"StartTime": "2020-03-05T00:30:00Z",
"BackupId": "20200305",
"BackupType": "Incremental"
},
{
"Status": "Succeeded",
"DataCenterId": "cn-shanghai-e",
"EndTime": "2020-03-06T15:53:06Z",
"ClusterId": "cds-uf6m0bod****6159",
"Size": 149188280,
"StartTime": "2020-03-06T00:30:00Z",
"BackupId": "20200306",
"BackupType": "Incremental"
}
]
}
}
Error codes
For a list of error codes, visit the API Error Center.