GetImage - Key Management Service - Alibaba Cloud Documentation Center

Retrieves information about a specified image.

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:GetImage

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ImageId	string	Yes	The image ID.	image-wz9c5ths5dfuwx47****

Response parameters

Parameter	Type	Description	Example
	object
Image	object	The information about the image.
BackupId	string	The backup ID.	backup-1618017313
CopyTime	integer	The time when the image was copied. This is a UNIX timestamp that is accurate to the millisecond.	1641275680000
ExportTime	integer	The time when the image was created. This is a UNIX timestamp that is accurate to the millisecond.	1786776567788
ImageId	string	The image ID.	image-wz9c5ths5dfuwx47****
InstanceId	string	The ID of the HSM instance.	hsm-cn-9lb32vll****
Mode	string	The image creation mode. PERIODIC: The image is created automatically. MANUAL: The image is created manually.	MANUAL
RegionId	string	The region ID.	cn-hangzhou
Remark	string	The remarks of the backup.	hsm-test
SourceBackupUid	string	The source backup ID.	backup-gfuiasdfa****
SourceImageUid	string	The source image ID.	image-kklhhhh****
SourceInstanceId	string	The source instance ID.	hsm-wz9fnmvx190shfbk****
SourceRegionId	string	The region ID of the source image.	cn-beijing
Status	string	The status of the image. NEW: The image is not enabled. DELETED: The image is deleted. CREATING: The image is being created. NORMAL: The image is created.	NEW
VsmDigest	string	The summary of the HSM instance.	3kGeHnmQzXwSsfF0Jk9eJYhe2gP6An0/HlYIiZh1****
RequestId	string	The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.	4C467B38-3910-447D-87BC-AC049166F216

Examples

Success response

JSON format

{
  "Image": {
    "BackupId": "backup-1618017313",
    "CopyTime": 1641275680000,
    "ExportTime": 1786776567788,
    "ImageId": "image-wz9c5ths5dfuwx47****",
    "InstanceId": "hsm-cn-9lb32vll****",
    "Mode": "MANUAL",
    "RegionId": "cn-hangzhou",
    "Remark": "hsm-test",
    "SourceBackupUid": "backup-gfuiasdfa****",
    "SourceImageUid": "image-kklhhhh****",
    "SourceInstanceId": "hsm-wz9fnmvx190shfbk****",
    "SourceRegionId": "cn-beijing",
    "Status": "NEW",
    "VsmDigest": "3kGeHnmQzXwSsfF0Jk9eJYhe2gP6An0/HlYIiZh1****"
  },
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
}

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.