DescribeDetachedBackups - PolarDB - Alibaba Cloud Documentation Center

Queries the information about the backup sets in a released PolarDB cluster.

Operation description

Before you call this operation, make sure that the PolarDB cluster is in the Released state. You must also confirm that the Retain All Backups Permanently or Retain Last Automatic Backup Permanently backup retention policy takes effect after you release the cluster. If you delete all backup sets after the cluster is released, you cannot use this API operation to query the cluster.

Note You can call the DescribeDBClusterAttribute operation to query the cluster status.

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:DescribeDetachedBackups	Read	dbcluster acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}	none	none

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.	111111111
BackupStatus	string	No	The status of the backup set. Valid values: Success Failed	Success
BackupMode	string	No	The backup mode. Valid values: Automated Manual	Manual
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
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-05-01T00: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-05-14T00:00Z
PageSize	integer	No	The number of entries per 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.	50
PageRecordCount	string	The number of entries per page.	15
RequestId	string	The ID of the request.	717B2382-BB14-4DCB-BBC2-32DBE0******
PageNumber	string	The page number.	1
Items	object []	Details about the backup sets.
BackupSetSize	string	The size of the backup set. 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.	7251056
ConsistentTime	string	The snapshot checkpoint time. The value is a Unix timestamp.	1589253947
StoreStatus	string	Indicates whether the backup set can be deleted. Valid values: Enabled: The backup set can be deleted. Disabled: The backup set cannot be deleted.	Disabled
BackupStatus	string	The status of the backup set. Valid values: Success Failed	Success
BackupType	string	The type of the backup. Only full backups are supported. The value is set to FullBackup.	FullBackup
BackupStartTime	string	The start time of the backup task. The time is displayed in UTC.	2020-05-12T03:25:44Z
IsAvail	string	Indicates whether the backup set is available. Valid values: 0: The data backup set is unavailable. 1: The data backup set is available.	1
BackupEndTime	string	The end time of the backup task. The time is displayed in UTC.	2020-05-12T03:25:55Z
BackupId	string	The ID of the backup set.	111111111
DBClusterId	string	The ID of the cluster.	pc-**************
BackupsLevel	string	The level of the backup set. Valid values: Level-1: level-1 backup set Level-2: level-2 backup set	Level-2
BackupMode	string	The backup mode. Valid values: Automated Manual	Manual
BackupMethod	string	The backup method. Only snapshot backups are supported. The value is set to Snapshot.	Snapshot

Examples

Sample success responses

JSONformat

{
  "TotalRecordCount": "50",
  "PageRecordCount": "15",
  "RequestId": "717B2382-BB14-4DCB-BBC2-32DBE0******",
  "PageNumber": "1",
  "Items": {
    "Backup": [
      {
        "BackupSetSize": "7251056",
        "ConsistentTime": "1589253947",
        "StoreStatus": "Disabled",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2020-05-12T03:25:44Z",
        "IsAvail": "1",
        "BackupEndTime": "2020-05-12T03:25:55Z",
        "BackupId": "111111111",
        "DBClusterId": "pc-**************",
        "BackupsLevel": "Level-2",
        "BackupMode": "Manual",
        "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.
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

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change
	delete Error Codes: 404

2023-06-12

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 404 change
	delete Error Codes: 400

2022-06-01

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 404
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: BackupRegion