DescribeBackups - PolarDB - Alibaba Cloud Documentation Center

Queries backup information for a PolarDB cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeBackups

get

*Backup

acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the cluster.	pc-****************
BackupId	string	No	The backup ID.	11111111
BackupStatus	string	No	The status of the backup. Valid values: Success: The backup is successful. Failed: The backup failed.	Success
BackupMode	string	No	The backup mode. Valid values: Automated: automatic backup Manual: manual backup	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. The end time must be later than the start time. Specify the time in the `YYYY-MM-DDThh:mmZ` format. The time must be in UTC.	2020-11-16T00:00Z
BackupRegion	string	No	The destination region of the cross-region backup. Note This parameter is supported only by PolarDB for MySQL.	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 an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
TotalRecordCount	string	The total number of entries.	1
PageRecordCount	string	The number of entries returned on the current page.	1
RequestId	string	The request ID.	24A1990B-4F6E-482B-B8CB-75C612******
PageNumber	string	The page number.	1
Items	object
Backup	array<object>	The details of the backup sets.
	object
BackupSetSize	string	The size of the backup file. Unit: bytes. Note Because snapshots share data blocks, the storage space that is released after you delete a snapshot backup is much smaller than the size of the backup file. For more information, see Backup FAQ.	4639948800
ConsistentTime	string	The point in time of the consistent snapshot. This value is a UNIX timestamp. Unit: seconds.	1605425407
BackupStatus	string	The status of the backup. Valid values: Success: The backup is successful. Failed: The backup failed.	Success
BackupType	string	The backup type. Only full backup is supported. The value is fixed as FullBackup.	FullBackup
BackupStartTime	string	The start time of the backup. The time is in UTC.	2020-11-15T07:30:05Z
ExpectExpireTime	string	The expected expiration time of the backup set. This parameter is supported only for instances for which the sparse backup feature is enabled.	2022-10-24T08:13:23Z
ExpectExpireType	string	The expected expiration type of the backup set. This parameter is supported only for instances for which the sparse backup feature is enabled. 枚举值： NEVER : NEVER EXPIRED : EXPIRED DELAY : DELAY	EXPIRED
IsAvail	string	Indicates whether the backup set is available. Valid values: 0: unavailable 1: available	0
BackupEndTime	string	The end time of the backup. The time is in UTC.	2020-11-15T07:30:20Z
BackupId	string	The backup ID.	61*******
DBClusterId	string	The cluster ID.	pc-****************
BackupsLevel	string	The level of the backup set. Valid values: Level-1: level-1 backup Level-2: level-2 backup	Level-1
BackupMode	string	The backup mode. Valid values: Automated: automatic backup Manual: manual backup	Automated
BackupMethod	string	The data backup method. Only snapshot backup is supported. The value is fixed as Snapshot.	Snapshot
TotalLevel2BackupSize	string	The total size of level-2 backups in the specified region. Unit: bytes. Note This parameter is supported only for clusters that use the PSL4 or PSL5 storage class. This parameter is supported only for clusters for which the level-2 backup feature is enabled. If this parameter is not returned, the size of the level-2 backup is 0.	4639948800

Examples

Success response

JSON format

{
  "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\u0000\u0000",
        "IsAvail": "0",
        "BackupEndTime": "2020-11-15T07:30:20Z",
        "BackupId": "61*******",
        "DBClusterId": "pc-****************",
        "BackupsLevel": "Level-1",
        "BackupMode": "Automated",
        "BackupMethod": "Snapshot"
      }
    ]
  },
  "TotalLevel2BackupSize": "4639948800"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.