All Products
Search
Document Center

AnalyticDB:DescribeBackups

Last Updated:Oct 21, 2026

Queries the backup list of a 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 None

Request parameters

Parameter

Type

Required

Description

Example

DBClusterId

string

Yes

The ID of the Data Warehouse Edition cluster.

Note

You can call the DescribeDBClusters operation to query the IDs of Data Warehouse Edition clusters in a specified 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. The end time 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 that are greater than 0 and do not exceed the maximum value of the Integer data type. Default value: 1.

1

CrossUid

string

No

The Alibaba Cloud account that owns the backup set in cross-account backup scenarios.

Note

Specify this parameter only for cross-account backups.

195****

CrossRole

string

No

The name of the RAM role under the Alibaba Cloud account that owns the backup set in cross-account backup scenarios.

Note

Specify this parameter only for cross-account backups.

role-for-xxx

RegionId

string

No

The region ID.

Note

You can call the DescribeRegions operation to query the regions and zones supported by AnalyticDB for MySQL, including region IDs.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

The list of backup sets.

FreeBackupSize

integer

The free backup storage size. Unit: bytes.

0

Items

object

Backup

array<object>

The list of backup sets.

object

The details of the backup set.

BackupEndTime

string

The end time of the backup. Format: yyyy-MM-ddTHH:mmZ.

2022-06-02T16:00Z

BackupExpiredTime

string

The expiration time of the backup set. Format: yyyy-MM-ddTHH:mmZ.

2022-07-02T16:00Z

BackupId

string

The ID of the backup set.

32732****

BackupMethod

string

The backup method. Only snapshot backup (Snapshot) is supported.

Snapshot

BackupSize

integer

The size of the backup file. Unit: bytes.

2167808

BackupStartTime

string

The start time of the backup. Format: yyyy-MM-ddTHH:mmZ.

2022-06-01T16:00Z

BackupStatus

string

The status of the backup. Valid values:

  • Running: The backup is in progress.

  • Finished: The backup is completed.

Finished

BackupType

string

The backup type. Valid values:

  • FullBackup: full backup

  • IncrementalBackup: incremental backup

FullBackup

DBClusterId

string

The ID of the Data Warehouse Edition cluster.

am-bp18934i73vb5****

PageNumber

string

The page number.

1

PageSize

string

The number of backup sets on the current page.

30

RequestId

string

The request ID.

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

TotalBackupSize

integer

The total size of the backup sets. Unit: bytes.

64953700

TotalCount

string

The total number of entries.

300

Examples

Success response

JSON format

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

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.