All Products
Search
Document Center

AnalyticDB:DescribeBackups

Last Updated:Aug 30, 2024

Queries a list of backup sets for an AnalyticDB for MySQL cluster.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
adb:DescribeBackupsget
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.
am-bp18934i73vb5****
BackupIdstringNo

The ID of the backup set.

32732****
StartTimestringYes

The beginning 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.

2022-06-01T16:00Z
EndTimestringYes

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. The end time must be later than the start time.

2022-06-02T16:00Z
PageSizeintegerNo

The number of entries per page. Valid values:

  • 30 (default)
  • 50
  • 100
30
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1
CrossUidstringNo

The Alibaba Cloud account to which the backup set belongs.

Note This parameter must be specified only when cross-account backup operations are performed.
195****
CrossRolestringNo

The Resource Access Management (RAM) role of the Alibaba Cloud account to which the backup set belongs.

Note This parameter must be specified only when cross-account backup operations are performed.
role-for-xxx
RegionIdstringNo

The region ID.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountstring

The total number of entries returned.

300
PageSizestring

The number of entries per page.

30
RequestIdstring

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumberstring

The page number.

1
Itemsarray<object>

The queried backup sets.

object

The queried backup set.

DBClusterIdstring

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

am-bp18934i73vb5****
BackupTypestring

The backup type. Valid values:

  • FullBackup
  • IncrementalBackup
FullBackup
BackupStartTimestring

The start time of the backup.

2022-06-01T16:00Z
BackupSizeinteger

The size of the backup set. Unit: bytes.

2167808
BackupEndTimestring

The end time of the backup.

2022-06-02T16:00Z
BackupIdstring

The backup set ID.

32732****
BackupMethodstring

The backup method. Only Snapshot is returned.

Snapshot

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
403CrossUser.CheckFailedThe 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
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

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

Change history

Change timeSummary of changesOperation
2024-05-30The Error code has changedView Change Details
2024-05-30The Error code has changed. The request parameters of the API has changedView Change Details
2023-11-14API Description Update. The Error code has changedView Change Details
2023-11-02API Description Update. The Error code has changed. The response structure of the API has changedView Change Details