ListBackups - Key Management Service - Alibaba Cloud Documentation Center

Retrieves a list of backup sets that meet specified conditions.

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

yundun-hsm:ListBackups

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
CurrentPage	integer	Yes	The current page number.	1
PageSize	integer	Yes	The number of backups to return on each page. Valid values: 1 to 1000.	20
Name	string	No	The name of the backup.	hsm-te****
BackupId	string	No	The ID of the backup.	backup-1648438****
InstanceId	string	No	The ID of the Hardware Security Module (HSM) instance.	hsm-cn-vj30bil8****

Response parameters

Parameter	Type	Description	Example
	object	The response.
Backups	array<object>	The list of returned backups.
	object	The details of a backup.
AutoImageCount	integer	The number of automatic backup images.	1
BackupHourInDay	string	The hour of the day when the backup is performed. The time is in 24-hour format.	13
BackupId	string	The ID of the backup.	backup-1648438****
BackupPeriod	integer	The automatic backup cycle, in days.	3
CreateTime	integer	The time when the backup was created. This is a timestamp in milliseconds.	1637229596000
ExpireTime	integer	The time when the backup expires. This is a timestamp in milliseconds.	1682417553781
InstanceId	string	The ID of the HSM instance that is associated with the backup.	hsm-cn-vj30bil8****
MaxImageCount	string	The number of images.	3
Name	string	The name of the backup.	backup-te****
NextImageCreateTime	integer	The time when the next image will be created. This is a timestamp in milliseconds.	1682417553781
OwnerInstanceId	string	The ID of the HSM instance that owns the backup. This parameter is returned only for backups of HSM instances outside the Chinese mainland. Its value is the same as InstanceId.	hsm-cn-vj30bil8****
RegionId	string	The region ID.	ap-southeast-1
ReleaseTime	integer	The time when the backup was released. This is a timestamp in milliseconds.	1641275680000
Remark	string	The remarks of the backup.	normal backup
SpInstanceId	string	The ID of the backup in the sales domain. This parameter is returned only for backups of HSM instances in the Chinese mainland.	backup-fdb897sdfg534-****
Status	string	The status of the backup. NEW: Not enabled EXPIRED: Expired ENABLED: Enabled	ENABLED
Type	string	The type of the backup. DEFAULT: Default backup NORMAL: Normal backup	NORMAL
CurrentPage	integer	The current page number.	1
PageSize	integer	The number of backups returned on each page.	20
RequestId	string	The ID of the request.	4C467B38-3910-447D-87BC-AC049166F216
TotalCount	integer	The total number of entries returned.	30

Examples

Success response

JSON format

{
  "Backups": [
    {
      "AutoImageCount": 1,
      "BackupHourInDay": "13",
      "BackupId": "backup-1648438****",
      "BackupPeriod": 3,
      "CreateTime": 1637229596000,
      "ExpireTime": 1682417553781,
      "InstanceId": "hsm-cn-vj30bil8****",
      "MaxImageCount": "3",
      "Name": "backup-te****",
      "NextImageCreateTime": 1682417553781,
      "OwnerInstanceId": "hsm-cn-vj30bil8****",
      "RegionId": "ap-southeast-1",
      "ReleaseTime": 1641275680000,
      "Remark": "normal backup",
      "SpInstanceId": "backup-fdb897sdfg534-****",
      "Status": "ENABLED",
      "Type": "NORMAL"
    }
  ],
  "CurrentPage": 1,
  "PageSize": 20,
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  "TotalCount": 30
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.