获取镜像列表 - ListImage
功能介绍
获取镜像列表。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/images
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
eihealth_project_id | 是 | String | 参数解释: 空间ID,您可以从获取空间ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 最小长度:1 最大长度:128 |
project_id | 是 | String | 参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 最小长度:1 最大长度:128 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
type | 否 | String | 参数解释: 镜像类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
name | 否 | String | 参数解释: 镜像名称。 约束限制: 不涉及 取值范围: 长度应在1-128之间。 默认取值: 不涉及 最小长度:1 最大长度:128 |
show_empty | 否 | Boolean | 参数解释: 是否展示无镜像版本的镜像。 约束限制: 不涉及 取值范围: 取值范围:true, false。 默认取值: 'true' 缺省值:true |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 最小长度:1 最大长度:32768 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
count | Integer | 参数解释: 镜像总数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
images | Array of ImageDetailRsp objects | 参数解释: 镜像详情列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 参数类型 | 描述 |
|---|---|---|
name | String | 参数解释: 镜像名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
id | String | 参数解释: 镜像ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
eihealth_project_id | String | 参数解释: 作业所属空间ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
eihealth_project_name | String | 参数解释: 作业所属空间名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
type | String | 参数解释: 镜像类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
chip_type | String | 参数解释: 镜像芯片类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
description | String | 参数解释: 镜像描述。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
tags | Array of strings | 参数解释: 镜像版本列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
user_name | String | 参数解释: 创建镜像的用户名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
user_id | String | 参数解释: 创建镜像的用户ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
create_type | String | 参数解释: 创建方式。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
create_time | String | 参数解释: 镜像创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
update_time | String | 参数解释: 镜像更新时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
source_project_name | String | 参数解释: 源空间名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
source_project_id | String | 参数解释: 源空间ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
source_resource_id | String | 参数解释: 源资源ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
chargeable | Boolean | 参数解释: 是否为计费的镜像。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
请求示例
查询镜像列表。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/images 响应示例
状态码:200
OK
{
"count" : 1,
"images" : [ {
"name" : "demoimage",
"id" : "d4fc37ee-831d-4f64-afca-e2fd05f0824d",
"type" : "APP",
"chip_type" : "X86",
"description" : "description",
"tags" : [ "v1.1" ],
"create_type" : "PLATFORM_CREATED",
"create_time" : "2021-01-21T10:54:06Z",
"update_time" : "2021-01-21T10:54:06Z",
"source_project_name" : "demo-project",
"source_project_id" : "d57g37ee-831d-4f64-afca-e2fd05f0824d",
"source_resource_id" : "5f40782b-3804-4684-a009-253265dd4592"
} ]
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
错误码
请参见错误码。

