DescribeBackups - PolarDB - Alibaba Cloud Documentation Center

Queries the backup details of a PolarDB cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the cluster.	pc-****************
BackupId	string	No	The ID of the backup set.	11111111
BackupStatus	string	No	The status of the backup set. Valid values: Success Failed	Success
BackupMode	string	No	The backup mode. Valid values: Automated Manual	Automated
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.	2020-11-14T00: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. The end time must be later than the start time.	2020-11-16T00:00Z
BackupRegion	string	No	The region where the cross-region data backup file of the instance is stored. Note This parameter is valid only for PolarDB for MySQL clusters.	cn-hangzhou
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 50 100 Default value: 30.	30
PageNumber	integer	No	The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
TotalRecordCount	string	The total number of returned entries.	1
PageRecordCount	string	The number of entries per page.	1
RequestId	string	The ID of the request.	24A1990B-4F6E-482B-B8CB-75C612******
PageNumber	string	The page number.	1
Items	array<object>	The details of backup sets.
	object
BackupSetSize	string	The size of the backup set. Unit: bytes. Note After you delete the target snapshot backups, the storage space that is consumed by the backups is released. The released storage space is smaller than the size of the backup file, because the snapshots share specific data blocks. For more information, see FAQ about backup.	4639948800
ConsistentTime	string	The snapshot checkpoint time. The value follows the Unix time format. Unit: seconds.	1605425407
BackupStatus	string	The status of the backup set. Valid values: Success Failed	Success
BackupType	string	The type of the backup. Only FullBackup may be returned.	FullBackup
BackupStartTime	string	The start time of the backup task. The time is displayed in UTC. Unit: seconds.	2020-11-15T07:30:05Z
ExpectExpireTime	string	The expected expiration time of the backup set. Note This parameter is supported only for instances that are enabled with sparse backup.	2022-10-24T08:13:23Z
ExpectExpireType	string	The expected expiration type of the backup set (This parameter is supported only for instances that are enabled with sparse backup). Valid values: NEVER EXPIRED DELAY	EXPIRED
IsAvail	string	Indicates whether the backup set is available. Valid values: 0: The backup set is unavailable. 1: The backup set is available.	0
BackupEndTime	string	The end time of the backup task. The time is displayed in UTC.	2020-11-15T07:30:20Z
BackupId	string	The ID of the backup set.	61*******
DBClusterId	string	The ID of the cluster.	pc-****************
BackupsLevel	string	The level of the backup set. Valid values: Level-1 Level-2	Level-1
BackupMode	string	The backup mode. Valid values: Automated Manual	Automated
BackupMethod	string	The backup method. Only Snapshot may be returned.	Snapshot

Examples

Sample success responses

JSONformat

{
  "TotalRecordCount": "1",
  "PageRecordCount": "1",
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "PageNumber": "1",
  "Items": {
    "Backup": [
      {
        "BackupSetSize": "4639948800",
        "ConsistentTime": "1605425407",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2020-11-15T07:30:05Z",
        "ExpectExpireTime": "2022-10-24T08:13:23Z",
        "ExpectExpireType": "EXPIRED",
        "IsAvail": "0",
        "BackupEndTime": "2020-11-15T07:30:20Z",
        "BackupId": "61*******",
        "DBClusterId": "pc-****************",
        "BackupsLevel": "Level-1",
        "BackupMode": "Automated",
        "BackupMethod": "Snapshot"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.
400	InvalidBackupStatus.Malformed	The specified parameter BackupStatus is not valid.	The specified BackupStatus parameter is invalid.
400	InvalidBackupMode.Malformed	The specified parameter BackupMode is not valid.	The specified BackupMode parameter is invalid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.	The specified StartTime parameter is invalid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.	The specified EndTime parameter is invalid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	The specified PageSize parameter is invalid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	The specified PageNumber parameter is invalid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-12	The Error code has changed	View Change Details
2023-05-26	The Error code has changed. The response structure of the API has changed	View Change Details
2022-06-01	The Error code has changed. The request parameters of the API has changed	View Change Details