Queries the backup details of an Apsara PolarDB cluster.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | DescribeBackups |
The operation that you want to perform. Set the value to DescribeBackups. |
DBClusterId | String | Yes | pc-**************** |
The ID of the Apsara PolarDB cluster. |
EndTime | String | Yes | 2020-05-02T00:00Z |
The end time of the query. The time must be in UTC. The format is Note The end time must be later than the start time.
|
StartTime | String | Yes | 2020-05-01T00:00Z |
The start time of the query. The time must be in UTC. The format is |
BackupId | String | No | 61******* |
The ID of the backup set. |
BackupStatus | String | No | Success |
The status of the backup task. Valid values:
|
BackupMode | String | No | Manual |
The backup policy. Valid values:
|
PageSize | Integer | No | 30 |
The number of entries to return on each page. Default value: 30. Valid values:
|
PageNumber | Integer | No | 1 |
The number of the page to return. Default value: 1. Valid values: non-zero positive integers. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Items | Array |
The details of the backup set. |
|
Backup | |||
BackupEndTime | String | 2020-05-01T22:56:43Z |
The end time of the backup. The time is displayed in UTC. |
BackupId | String | 61******* |
The ID of the backup set. |
BackupMethod | String | Snapshot |
The backup method. Only snapshot backups are supported. The value of this parameter is Snapshot. |
BackupMode | String | Automated |
The backup policy. Valid values:
|
BackupSetSize | String | 154920107 |
The size of the backup file. Unit: bytes. Note After you delete the target snapshot backups, the storage space consumed by the backups
is released. The released storage space is smaller than the size of the backup file,
because the snapshots share certain data blocks.
|
BackupStartTime | String | 2020-05-01T22:56:28Z |
The start time of the backup. The time is displayed in UTC. |
BackupStatus | String | Success |
The status of the backup task. Valid values:
|
BackupType | String | FullBackup |
The type of the backup. Only full backups are supported. The value of this parameter is FullBackup. |
BackupsLevel | String | Level-2 |
The level of the backup set. Valid values:
|
ConsistentTime | String | 1589418586 |
The snapshot checkpoint time. The value is a Unix timestamp. |
DBClusterId | String | pc-**************** |
The ID of the cluster. |
IsAvail | String | 0 |
Indicates whether the backup set is available. Valid values:
|
StoreStatus | String | Disabled |
Indicates whether the backup set can be deleted. Valid values:
|
PageNumber | String | 1 |
The page number of the returned page. |
PageRecordCount | String | 1 |
The number of entries returned on the current page. |
RequestId | String | EAF5BFA9-78FD-486B-9C76-DF292****** |
The ID of the request. |
TotalRecordCount | String | 1 |
The total number of entries that were returned. |
Examples
Sample requests
http(s)://polardb.aliyuncs.com/? Action=DescribeBackups
&DBClusterId=pc-****************
&EndTime=2020-05-02T00:00Z
&StartTime=2020-05-01T00:00Z
&<Common request parameters>
Sample success responses
XML
format
<TotalRecordCount>1</TotalRecordCount>
<PageRecordCount>1</PageRecordCount>
<RequestId>EAF5BFA9-78FD-486B-9C76-DF292******</RequestId>
<PageNumber>1</PageNumber>
<Items>
<Backup>
<BackupMethod>Snapshot</BackupMethod>
<BackupMode>Automated</BackupMode>
<BackupsLevel>Level-2</BackupsLevel>
<DBClusterId>pc-****************</DBClusterId>
<BackupId>61*******</BackupId>
<IsAvail>1</IsAvail>
<BackupSetSize>154920107</BackupSetSize>
<StoreStatus>Disabled</StoreStatus>
<BackupEndTime>2020-05-01T22:56:43Z</BackupEndTime>
<BackupStartTime>2020-05-01T22:56:28Z</BackupStartTime>
<ConsistentTime>1588373790</ConsistentTime>
<BackupType>FullBackup</BackupType>
<BackupStatus>Success</BackupStatus>
</Backup>
</Items>
JSON
format
{
"TotalRecordCount": 1,
"PageRecordCount": 1,
"RequestId": "EAF5BFA9-78FD-486B-9C76-DF292******",
"PageNumber": 1,
"Items": {
"Backup": [
{
"BackupMethod": "Snapshot",
"BackupMode": "Automated",
"BackupsLevel": "Level-2",
"DBClusterId": "pc-****************",
"BackupId": "61*******",
"IsAvail": 1,
"BackupSetSize": 154920107,
"StoreStatus": "Disabled",
"BackupEndTime": "2020-05-01T22:56:43Z",
"BackupStartTime": "2020-05-01T22:56:28Z",
"ConsistentTime": 1588373790,
"BackupType": "FullBackup",
"BackupStatus": "Success"
}
]
}
}
Error codes
For a list of error codes, visit the API Error Center.