HSM Image Types & Architecture Overview - Key Management Service - Alibaba Cloud - Key Management Service

Queries the images that meet the 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:ListImages

list

*All Resource

*

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 elements

Element	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.
	object	The image details.
BackupId	string	The ID of the backup.	backup-fdb897sdf****
ExportTime	integer	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

Success response

JSON format

{
  "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	Description
403	NoPermission	caller has no permission
403	Backup.Deleted	Backup has been deleted.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.