DescribeDetachedBackups - API Reference| Alibaba Cloud Documentation Center

Before you call this operation, make sure that the Apsara PolarDB cluster is in the Released state. Another prerequisite is that the Retain All Backups Permanently or Retain Last Automatic Backup Permanently backup retention policy takes effect after you delete the cluster. If you delete all backup sets after the cluster is deleted, you cannot use this API operation to retrieve 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	No	DescribeDetachedBackups	The operation that you want to perform. Set the value to DescribeDetachedBackups.
DBClusterId	String	Yes	pc-****************	The ID of the cluster.
EndTime	String	Yes	2020-05-14T00: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.
StartTime	String	Yes	2020-05-01T00: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.
BackupId	String	No	111111111	The ID of the backup.
BackupStatus	String	No	Success	The status of the backup task. Valid values: Success: The backup task is completed. Failed: The backup task failed.
BackupMode	String	No	Manual	The backup mode. Valid values: Automated: automatic backup Manual: manual backup
PageSize	Integer	No	30	The number of entries to return on each page. Valid values: 30 50 100 Default value: 30.
PageNumber	Integer	No	1	The number of the page to return. The value must be an integer that is larger than 0. Default value: 1.

Response parameters


Parameter	Type	Example	Description
Items	Array of Backup		The details of the backup set.
Backup
BackupEndTime	String	2020-05-12T03:25:55Z	The time when this backup task ended. The time is displayed in UTC.
BackupId	String	111111111	The ID of the backup.
BackupMethod	String	Snapshot	The backup method. Only snapshot backups are supported. The value is set to Snapshot.
BackupMode	String	Manual	The backup mode. Valid values: Automated: automatic backup Manual: manual backup
BackupSetSize	String	7251056	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-12T03:25:44Z	The time when this backup task started. The time is displayed in UTC.
BackupStatus	String	Success	The status of the backup task. Valid values: Success: The backup is successful. Failed: The backup task failed.
BackupType	String	FullBackup	The type of the backup. Only full backups are supported. Set the value to FullBackup.
BackupsLevel	String	Level-2	The level of the backup set. Valid values: Level-1: level-1 backup set Level-2: level-2 backup set
ConsistentTime	String	1589253947	The snapshot checkpoint time. The value is a Unix timestamp.
DBClusterId	String	pc-**************	The ID of the PolarDB cluster whose node is to be deleted.
IsAvail	String	1	Indicates whether the backup set is available. Valid values: 0: The backup set is unavailable. 1: The backup set is available.
StoreStatus	String	Disabled	Indicates whether the backup set can be deleted. Valid values: Enabled: The backup set can be deleted. Disabled: The backup set cannot be deleted.
PageNumber	String	1	The page number of the page returned.
PageRecordCount	String	1	The number of entries returned per page.
RequestId	String	717B2382-BB14-4DCB-BBC2-32DBE0******	The ID of the request.
TotalRecordCount	String	1	The total number of entries returned.

Examples

Sample request

http(s)://polardb.aliyuncs.com/? Action=DescribeDetachedBackups
&DBClusterId=pc-****************
&EndTime=2020-05-14T00:00Z
&StartTime=2020-05-01T00:00Z
&<Common request parameters>

Sample success responses

XML format

<DescribeDetachedBackupsResponse>
  <TotalRecordCount>1</TotalRecordCount>
  <PageRecordCount>1</PageRecordCount>
  <RequestId>717B2382-BB14-4DCB-BBC2-32DBE0******</RequestId>
  <PageNumber>1</PageNumber>
  <Items>
        <Backup>
              <BackupMethod>Snapshot</BackupMethod>
              <BackupMode>Manual</BackupMode>
              <BackupsLevel>Level-2</BackupsLevel>
              <DBClusterId>pc-***************</DBClusterId>
              <BackupId>62*******</BackupId>
              <IsAvail>1</IsAvail>
              <BackupSetSize>7251056</BackupSetSize>
              <StoreStatus>Enabled</StoreStatus>
              <BackupEndTime>2020-05-12T03:25:55Z</BackupEndTime>
              <BackupStartTime>2020-05-12T03:25:44Z</BackupStartTime>
              <ConsistentTime>1589253947</ConsistentTime>
              <BackupType>FullBackup</BackupType>
              <BackupStatus>Success</BackupStatus>
        </Backup>
  </Items>
</DescribeDetachedBackupsResponse>

JSON format

{
    "TotalRecordCount": 1,
    "PageRecordCount": 1,
    "RequestId": "717B2382-BB14-4DCB-BBC2-32DBE0******",
    "PageNumber": 1,
    "Items": {
        "Backup": [
            {
                "BackupMethod": "Snapshot",
                "BackupMode": "Manual",
                "BackupsLevel": "Level-2",
                "DBClusterId": "pc-***************",
                "BackupId": "62*******",
                "IsAvail": 1,
                "BackupSetSize": 7251056,
                "StoreStatus": "Enabled",
                "BackupEndTime": "2020-05-12T03:25:55Z",
                "BackupStartTime": "2020-05-12T03:25:44Z",
                "ConsistentTime": 1589253947,
                "BackupType": "FullBackup",
                "BackupStatus": "Success"
            }
        ]
    }
}

Error codes

For a list of error codes, visit the API Error Center.