ListBackups - Key Management Service - Alibaba Cloud Documentation Center

Queries the backups that meet the query conditions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-hsm:ListBackups	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
CurrentPage	long	Yes	The page number.	1
PageSize	long	Yes	The number of entries per 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).	hsm-cn-vj30bil8****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Backups	array<object>	The backups returned.
backup	object	The information about the backup.
AutoImageCount	long	The number of images that are automatically backed up.	1
BackupHourInDay	string	The backup time on the hour that is in the 24-hour clock.	13
BackupId	string	The ID of the backup.	backup-1648438****
BackupPeriod	long	The automatic backup cycle. Unit: days.	3
CreateTime	long	The time when the backup is created. The value is accurate to the millisecond. The value is a UNIX timestamp.	1637229596000
ExpireTime	long	The expiration time of the backup. The value is accurate to the millisecond. The value is a UNIX timestamp.	1682417553781
InstanceId	string	The ID of the HSM 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	long	The time when the image is created next time. The value is accurate to the millisecond. The value is a UNIX timestamp.	1682417553781
OwnerInstanceId	string	The ID of the HSM to which the backup belongs. This parameter is available only for HSM backups outside the Chinese mainland and the value of this parameter is consistent with the value of InstanceId.	hsm-cn-vj30bil8****
RegionId	string	The ID of the region.	ap-southeast-1
ReleaseTime	long	The time when the backup is released. The value is accurate to the millisecond. The value is a UNIX timestamp.	1641275680000
Remark	string	The description of the backup.	normal backup
SpInstanceId	string	The ID of the backup. This parameter is available only for HSM backups in the Chinese mainland.	backup-fdb897sdfg534-****
Status	string	The status of the backup. Valid values: NEW: The backup is disabled. EXPIRED: The backup expired. ENABLED: The backup is enabled.	ENABLED
Type	string	The type of the backup. Valid values: DEFAULT NORMAL	NORMAL
CurrentPage	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
RequestId	string	The request ID.	4C467B38-3910-447D-87BC-AC049166F216
TotalCount	integer	The total number of entries returned.	30

Examples

Sample success responses

JSONformat

{
  "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
403	NoPermission	caller has no permission

For a list of error codes, visit the Service error codes.