ListImages - Key Management Service - Alibaba Cloud Documentation Center

Queries the images that meet the specified 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:ListImages	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
BackupId	string	Yes	The ID of the backup.	backup-fdb897sdf****
RegionId	string	Yes	The ID of the region.	cn-hangzhou
PageSize	integer	Yes	The number of images per page. Valid values: 1 to 1000.	20
CurrentPage	integer	Yes	The page number.	1
Mode	string	No	The image generation mode. Valid values: PERIODIC: It is automatically generated. MANUAL: It is manually generated.	MANUAL

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	4C467B38-3910-447D-87BC-AC049166F216
TotalCount	integer	The total number of images returned.	1000
PageSize	integer	The number of images per page.	20
CurrentPage	integer	The page number.	1
Images	array<object>	The images returned.
image	object	The image details.
BackupId	string	The ID of the backup.	backup-fdb897sdf****
ExportTime	long	The time when the image was generated. Unit: milliseconds. The value is a UNIX timestamp.	1782849566738
ImageId	string	The ID of the image.	image-d79x4k11pmg19****
InstanceId	string	The ID of the hardware security module (HSM).	hsm-cn-6ja1xknf****
RegionId	string	The ID of the region.	cn-hangzhou
Remark	string	The description of the backup.	hsm-test
Status	string	The status of the image. Valid values: NEW: It is disabled. DELETED: It is deleted. CREATING: It is being created. NORMAL: It is created.	CREATING
Mode	string	The image generation mode. Valid values: PERIODIC: It is automatically generated. MANUAL: It is manually generated.	MANUAL
VsmDigest	string	The digest of the HSM.	3kGeHnmQzXwSsfF0Jk9eJYhe2gP6An0/HlYIiZh1****
SourceImageUid	string	The ID of the source image.	image-ooopjygsn****
SourceBackupUid	string	The ID of the source backup.	backup-hodfhaol****
SourceRegionId	string	The ID of the region in which the source image resides.	cn-shanghai
SourceInstanceId	string	The ID of the source HSM.	hsm-cn-wz9i2dmefudfxtmb****
CopyTime	string	The time when the image was copied. Unit: milliseconds. The value is a UNIX timestamp.	1641275680000

Examples

Sample success responses

JSONformat

{
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  "TotalCount": 1000,
  "PageSize": 20,
  "CurrentPage": 1,
  "Images": [
    {
      "BackupId": "backup-fdb897sdf****",
      "ExportTime": 1782849566738,
      "ImageId": "image-d79x4k11pmg19****",
      "InstanceId": "hsm-cn-6ja1xknf****",
      "RegionId": "cn-hangzhou",
      "Remark": "hsm-test",
      "Status": "CREATING",
      "Mode": "MANUAL",
      "VsmDigest": "3kGeHnmQzXwSsfF0Jk9eJYhe2gP6An0/HlYIiZh1****",
      "SourceImageUid": "image-ooopjygsn****",
      "SourceBackupUid": "backup-hodfhaol****",
      "SourceRegionId": "cn-shanghai",
      "SourceInstanceId": "hsm-cn-wz9i2dmefudfxtmb****",
      "CopyTime": "1641275680000"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
403	NoPermission	caller has no permission
403	Backup.Deleted	Backup has been deleted.

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