GetImage - 查询镜像_密钥管理服务(KMS)-阿里云帮助中心

查询指定镜像信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-hsm:GetImage

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ImageId	string	是	镜像 ID。	image-wz9c5ths5dfuwx47****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	4C467B38-3910-447D-87BC-AC049166F216
Image	object	返回的镜像信息。
BackupId	string	备份 ID。	backup-1618017313
ExportTime	integer	镜像生成时间，精确到毫秒。时间戳格式。	1786776567788
ImageId	string	镜像 ID。	image-wz9c5ths5dfuwx47****
InstanceId	string	密码机实例 ID。	hsm-cn-9lb32vll****
RegionId	string	地域 ID。	cn-hangzhou
Remark	string	备份备注。	hsm-test
Status	string	镜像状态。 NEW：未启用 DELETED：已删除 CREATING：创建中 NORMAL：创建完成	NEW
Mode	string	镜像生成模式。 PERIODIC：自动生成 MANUAL：手动生成	MANUAL
VsmDigest	string	密码机实例摘要。	3kGeHnmQzXwSsfF0Jk9eJYhe2gP6An0/HlYIiZh1****
SourceImageUid	string	源镜像 ID。	image-kklhhhh****
SourceRegionId	string	源镜像的地域 ID。	cn-beijing
SourceBackupUid	string	源备份 ID。	backup-gfuiasdfa****
SourceInstanceId	string	源实例 ID。	hsm-wz9fnmvx190shfbk****
CopyTime	integer	镜像复制时间，精确到毫秒。时间戳格式。	1641275680000

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
403	NoPermission	caller has no permission

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。