DescribeBackups - AnalyticDB - Alibaba Cloud Documentation Center

Lists backups for an AnalyticDB for MySQL 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

adb:DescribeBackups

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL cluster. Note Call DescribeDBClusters to list cluster IDs in a region.	am-bp18934i73vb5****
BackupId	string	No	The ID of the backup set.	32732****
StartTime	string	No	The start time of the query. Format: yyyy-MM-ddTHH:mmZ.	2022-06-01T16:00Z
EndTime	string	No	The end time of the query. It must be later than the start time. Format: yyyy-MM-ddTHH:mmZ.	2022-06-02T16:00Z
PageSize	integer	No	The number of entries per page. Valid values: 30 (default) 50 100	30
PageNumber	integer	No	The page number. Valid values: positive integers greater than 0 and no larger than the maximum value of the integer data type. Default value: 1.	1
CrossUid	string	No	The Alibaba Cloud account ID of the backup set owner. Note Specify this parameter only when backing up across Alibaba Cloud accounts.	195****
CrossRole	string	No	The RAM role name of the backup set owner's Alibaba Cloud account. Note Specify this parameter only when backing up across Alibaba Cloud accounts.	role-for-xxx
RegionId	string	No	The region ID. Note Call DescribeRegions to list supported regions and zones for AnalyticDB for MySQL, including region IDs.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The list of backup sets.
TotalCount	string	The total number of backup sets.	300
PageSize	string	The number of backup sets on the current page.	30
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumber	string	The page number.	1
FreeBackupSize	integer	The free backup size, in bytes.	0
TotalBackupSize	integer	The total backup size, in bytes.	64953700
Items	object
Backup	array<object>	The list of backup sets.
	object	Details of a backup set.
DBClusterId	string	The ID of the AnalyticDB for MySQL cluster.	am-bp18934i73vb5****
BackupType	string	The backup type. Valid values: FullBackup: full backup. IncrementalBackup: incremental backup.	FullBackup
BackupStartTime	string	The start time of the backup.	2022-06-01T16:00Z
BackupSize	integer	The size of the backup file, in bytes.	2167808
BackupEndTime	string	The end time of the backup.	2022-06-02T16:00Z
BackupExpiredTime	string	The expiration time of the backup set.	2022-07-02T16:00Z
BackupId	string	The ID of the backup set.	32732****
BackupMethod	string	The backup method. Only snapshot backup is supported.	Snapshot
BackupStatus	string	The status of the backup. Valid values: Running: The backup is in progress. Finished: The backup has completed.	Finished

Examples

Success response

JSON format

{
  "TotalCount": "300",
  "PageSize": "30",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber": "1",
  "FreeBackupSize": 0,
  "TotalBackupSize": 64953700,
  "Items": {
    "Backup": [
      {
        "DBClusterId": "am-bp18934i73vb5****",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-06-01T16:00Z",
        "BackupSize": 2167808,
        "BackupEndTime": "2022-06-02T16:00Z",
        "BackupExpiredTime": "2022-07-02T16:00Z",
        "BackupId": "32732****",
        "BackupMethod": "Snapshot",
        "BackupStatus": "Finished"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	CrossUser.CheckFailed	The input UID and role is not authorized.	cross-account authentication failed. check whether the entered uid and role are correct, and whether the role trusts the adb service account
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.