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

查询符合条件的镜像集合。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-hsm:ListImages	list	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
BackupId	string	是	备份 ID。	backup-fdb897sdf****
RegionId	string	是	地域 ID。	cn-hangzhou
PageSize	integer	是	每页显示的镜像个数。取值：1~1000。	20
CurrentPage	integer	是	当前分页。	1
Mode	string	否	镜像生成模式。 PERIODIC：自动生成 MANUAL：手动生成	MANUAL

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	4C467B38-3910-447D-87BC-AC049166F216
TotalCount	integer	返回的镜像总量。	1000
PageSize	integer	每页显示的镜像个数。	20
CurrentPage	integer	当前分页。	1
Images	array<object>	返回的镜像信息列表。
	object	镜像详情。
BackupId	string	备份 ID。	backup-fdb897sdf****
ExportTime	long	镜像生成时间，精确到毫秒。时间戳格式。	1782849566738
ImageId	string	镜像 ID。	image-d79x4k11pmg19****
InstanceId	string	密码机实例 ID。	hsm-cn-6ja1xknf****
RegionId	string	地域 ID。	cn-hangzhou
Remark	string	备份备注。	hsm-test
Status	string	镜像状态。 NEW：未启用 DELETED：已删除 CREATING：创建中 NORMAL：创建完成	CREATING
Mode	string	镜像生成模式。 PERIODIC：自动生成 MANUAL：手动生成	MANUAL
VsmDigest	string	密码机实例摘要。	3kGeHnmQzXwSsfF0Jk9eJYhe2gP6An0/HlYIiZh1****
SourceImageUid	string	源镜像 ID。	image-ooopjygsn****
SourceBackupUid	string	源备份 ID。	backup-hodfhaol****
SourceRegionId	string	源镜像所在的地域 ID。	cn-shanghai
SourceInstanceId	string	源密码机实例 ID。	hsm-cn-wz9i2dmefudfxtmb****
CopyTime	string	镜像复制时间，精确到毫秒。时间戳格式。	1641275680000

示例

正常返回示例

JSON格式

{
  "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"
    }
  ]
}

错误码

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

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