DescribeBackups - AnalyticDB - Alibaba Cloud Documentation Center

Queries the backup sets for an instance.

Operation description

For information about the endpoints for this service, see Endpoints.

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

*DBClusterLakeVersion

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the Data Lakehouse Edition cluster. Note Call the DescribeDBClusters operation to query the IDs of all clusters in a specific region.	am-bp18934i73vb5****
BackupId	string	No	The backup set ID.	1679758862
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format.	2011-06-01T16: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.	2023-02-20T02:30Z
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 a positive integer that does not exceed the maximum value of the integer data type. Default value: 1.	1
Remote	boolean	No	Specifies whether to query only cross-region backups. Set the value to true to query only cross-region backups. Set the value to false to query only local backups.	false

Response elements

Element	Type	Description	Example
	object
TotalCount	string	The total number of entries.	300
PageSize	string	The number of backup sets on the current page.	30
RequestId	string	The request ID.	CE17270B-F8F8-5A31-9DB4-DADDFDAD7940
PageNumber	string	The page number.	1
FreeBackupSize	integer	The free backup space. Unit: bytes.	0
TotalBackupSize	integer	The total size of the backup sets. Unit: bytes.	64953700
Items	object
Backup	array<object>	The list of backup sets.
	object
DBClusterId	string	The ID of the Data Lakehouse Edition cluster.	am-bp11q28kvl688****
BackupType	string	The backup type. Valid values: FullBackup: A full backup. IncrementalBackup: An incremental backup.	FullBackup
BackupStartTime	string	The start time of the backup.	2022-06-01T16:00Z
BackupSize	integer	The size of the backup file. Unit: 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 backup set ID.	32732****
BackupMethod	string	The backup method. Only snapshot backup is supported.	Snapshot
BackupRegion	string	The region where the cross-region backup is stored.	cn-hangzhou
ParentBackupId	string	The ID of the local backup set that is associated with the cross-region backup.	32733****
BackupStatus	string	The backup status. Valid values: Running: The backup is in progress. Finished: The backup is complete.	Finished

Examples

Success response

JSON format

{
  "TotalCount": "300",
  "PageSize": "30",
  "RequestId": "CE17270B-F8F8-5A31-9DB4-DADDFDAD7940",
  "PageNumber": "1",
  "FreeBackupSize": 0,
  "TotalBackupSize": 64953700,
  "Items": {
    "Backup": [
      {
        "DBClusterId": "am-bp11q28kvl688****",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-06-01T16:00Z",
        "BackupSize": 2167808,
        "BackupEndTime": "2022-06-02T16:00Z",
        "BackupExpiredTime": "2022-07-02T16:00Z\n",
        "BackupId": "32732****",
        "BackupMethod": "Snapshot",
        "BackupRegion": "cn-hangzhou",
        "ParentBackupId": "32733****",
        "BackupStatus": "Finished"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.