ListImages - 查询镜像列表_弹性高性能计算(E-HPC)-阿里云帮助中心

查询镜像列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ehpc:ListImages	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
PageNumber	long	否	当前页码。默认值：1。	1
PageSize	long	否	每页条数。默认值：20。	10
ImageCategory	string	否	镜像来源。取值范围： Public：阿里云提供的公共镜像。 Custom：您添加的自定义镜像。	Custom
ImageType	string	否	镜像类型。取值范围： VM：虚拟机镜像。 Container：容器镜像。默认值：VM	VM
ImageIds	array	否	镜像 ID 数组。
	string	否	镜像 ID。	m-uf6bzz76jb4ai9******
ImageNames	array	否	镜像名称数组。
	string	否	镜像名称。	appimage
Mode	string	否	查询模式。取值范围： List：查询对应所有镜像版本列表。 Merge：归并查询各镜像最新版本列表。	Merge

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	896D338C-E4F4-41EC-A154-D605E5DE****
Success	boolean	执行命令并获取结果的过程是否成功。取值范围： true：成功。 false：失败。	true
TotalCount	integer	本次请求条件下的数据总量。	1
PageSize	long	每页条数。	20
PageNumber	long	当前页码。	1
Images	array<object>	镜像信息列表。
Image	object	镜像信息。
ImageType	string	镜像类型。	VM
ImageId	string	镜像 ID。	m-bp181x855551ww5yq****
AppId	string	应用 ID。	ci-vm-kHLPzEWun6zz****
Name	string	镜像名称。	app-image
Version	string	镜像版本。	v1.0
Description	string	镜像描述。	应用测试镜像。
CreateTime	string	创建时间。	2022-12-09T07:06:34Z
OsTag	string	OS 具体版本标识。	Ubuntu 22.04 64 bit
UpdateTime	string	镜像更新时间。	2024-09-25 14:15:28
DocumentId	integer	文档 ID。	30
Weight	integer	权重。	70

示例

正常返回示例

JSON格式

{
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****",
  "Success": true,
  "TotalCount": 1,
  "PageSize": 20,
  "PageNumber": 1,
  "Images": [
    {
      "ImageType": "VM",
      "ImageId": "m-bp181x855551ww5yq****",
      "AppId": "ci-vm-kHLPzEWun6zz****",
      "Name": "app-image",
      "Version": "v1.0",
      "Description": "应用测试镜像。",
      "CreateTime": "2022-12-09T07:06:34Z",
      "OsTag": "Ubuntu  22.04 64 bit",
      "UpdateTime": "2024-09-25 14:15:28",
      "DocumentId": 30,
      "Weight": 70
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The specified parameter %s is invalid.	无效的参数：%s
400	InDebt	Your account has overdue payments.	您的账户已欠费
400	NotEnabled	You have not enabled this service.	您的账户还未开通此服务
406	EcsError	An error occurred while calling the ECS API operation.	ECS API调用出错
406	AliyunError	An Alibaba Cloud product error occurred.	阿里云产品错误. %s
406	DbError	A database error occurred.	数据库错误
407	NotAuthorized	No authorization is granted.	未授权
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	请求失败，服务暂时不可用

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

变更历史

变更时间	变更内容概要	操作
2024-12-18	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-12-05	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-11-18	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-05-14	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情