DescribeBackupSets - PolarDB - Alibaba Cloud Documentation Center

Calls the DescribeBackupSets operation to query backup set information.

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

drds:DescribeBackupSets

get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID of the DRDS instance.	drds***********
StartTime	string	Yes	The start time of the query. Specify a timestamp in milliseconds.	1591327800000
EndTime	string	Yes	The end time of the query. Specify a timestamp in milliseconds. Note The end time must be later than the start time.	1591326000000

Response elements

Element	Type	Description	Example
	object
Success	boolean	The result of the request.	true
RequestId	string	The request ID.	7103AEE3-9025-442F-B82B-BABD0A******
BackupSets	object
backupSet	array<object>	The list of backup sets.
	array<object>
EnableRecovery	boolean	Indicates whether the backup set can be restored. Valid values:	false
Status	integer	The status of the backup instance. Valid values: -1: Failed 0: Not started 1: The storage instance is running. 2: Success	2
BackupConsitentTime	string	Backup Recovery duration.	2020-06-05 11:31:38
BackupType	string	The type of the backup. Valid values: manual: indicates a manual backup. auto: indicates an automatic backup.	manual
BackupStartTime	integer	The beginning of the backup time which is in timestamp format (measured in millisecond).	1591327754000
BackupLevel	string	The level of the backup. Valid values: db: The database level. instance: the instance level.	instance
BackupMode	string	The backup method. Valid values: logic: the logical backup. phy: fast backup	logic
BackupEndTime	integer	The end of the backup time which is in timestamp format (measured in millisecond). Note 0 indicates not finished.	1591327899000
Id	string	The ID of the data backup file you want to use.	ba30d5c4-a6dc-11ea-bd40-************
BackupTotalSize	string	The size of the backup set. Unit: MB.	93.24
BackupDbs	object
backupDb	array	The list of backup databases.
	string		["dts********"]

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "7103AEE3-9025-442F-B82B-BABD0A******",
  "BackupSets": {
    "backupSet": [
      {
        "EnableRecovery": false,
        "Status": 2,
        "BackupConsitentTime": "2020-06-05 11:31:38",
        "BackupType": "manual",
        "BackupStartTime": 1591327754000,
        "BackupLevel": "instance",
        "BackupMode": "logic",
        "BackupEndTime": 1591327899000,
        "Id": "ba30d5c4-a6dc-11ea-bd40-************",
        "BackupTotalSize": "93.24",
        "BackupDbs": {
          "backupDb": [
            "[\"dts********\"]"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.