DescribeBackupSetList - PolarDB - Alibaba Cloud Documentation Center

Queries the list of backup sets by calling the DescribeBackupSetList operation.

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

polardbx:DescribeBackupSetList

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the instance resides.	cn-hangzhou
DBInstanceName	string	Yes	The name of the instance.	pxc-xxxxxx
StartTime	integer	No	The start time timestamp, in milliseconds.	1635707845000
EndTime	integer	No	The end time timestamp, in milliseconds.	1635707845000
PageSize	integer	No	The number of entries per page.	30
PageNumber	integer	No	The page number, starting from 1.	1
DestCrossRegion	string	No	The region where the backup set resides. After you specify this parameter, backup sets in the specified region are returned. Only one region can be specified at a time.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
Message	string	The returned message. "success" is returned if the request is successful. Otherwise, an error code is returned.	success
RequestId	string	The request ID.	1A6D328C-84B8-40DC-BF49-6C73984D7494
Success	boolean	Indicates whether the request is successful.	true
Data	array<object>	The data struct.
	object
EndTime	integer	The backup end time.	1635706960956
Status	integer	The status of the backup set. Valid values: 0: Backing up. 1: Backup succeeded. 2: Backup failed.	1
BackupSetSize	integer	The size of the backup set, in bytes.	88803195
BackupSetId	string	The backup set ID.	111
BackupType	integer	The backup type. Valid values: 0: fast backup. 1: consistent backup.	1
BeginTime	integer	The backup start time.	1635706960956
BackupModel	integer	The backup mode. Valid values: 0: automatic backup. 1: manual backup.	0

Examples

Success response

JSON format

{
  "Message": "success",
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "Success": true,
  "Data": [
    {
      "EndTime": 1635706960956,
      "Status": 1,
      "BackupSetSize": 88803195,
      "BackupSetId": "111",
      "BackupType": 1,
      "BeginTime": 1635706960956,
      "BackupModel": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.