获取用户所属空间的镜像列表
功能介绍
获取用户所属空间的镜像列表。
URI
GET /v1/{project_id}/eihealth-projects/images
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 最小长度:1 最大长度:128 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
is_creator |
否 |
Boolean |
参数解释: 是否仅展示本人创建资源。 约束限制: 不涉及 取值范围: true或者false 默认取值: true 缺省值:true |
image_id |
否 |
String |
参数解释: 镜像ID,支持精确搜索。 约束限制: 不涉及 取值范围: 仅支持字母、数字、下划线和中划线,长度范围1到128。 默认取值: 不涉及 最小长度:1 最大长度:128 |
image_name |
否 |
String |
参数解释: 镜像名称,支持模糊搜索。 约束限制: 不涉及 取值范围: 长度范围1到128。 默认取值: 不涉及 最小长度:1 最大长度:128 |
description |
否 |
String |
参数解释: 镜像描述,支持模糊搜索。 约束限制: 不涉及 取值范围: 长度范围1到1024。 默认取值: 不涉及 最小长度:1 最大长度:1024 |
eihealth_project_names |
否 |
Array of strings |
参数解释: 空间名称列表,支持查询多个空间下的镜像。 约束限制: 不涉及 取值范围: 每个空间名称长度为1到512个字符,最多支持10个空间名称。 默认取值: 不涉及 最小长度:1 最大长度:512 数组长度:0 - 10 |
source_project_name |
否 |
String |
参数解释: 源空间名称,支持模糊搜索。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 最小长度:1 最大长度:512 |
types |
否 |
Array of strings |
参数解释: 镜像类型列表。 约束限制: 不涉及 取值范围: 长度范围1到32。 默认取值: 不涉及 最小长度:1 最大长度:32 数组长度:0 - 3 |
start_create_time |
否 |
Long |
参数解释: 最小创建时间。 约束限制: 不涉及 取值范围: 时间戳,范围为1000000000000到9999999999999。 默认取值: 不涉及 最小值:1000000000000 最大值:9999999999999 |
end_create_time |
否 |
Long |
参数解释: 最大创建时间。 约束限制: 不涉及 取值范围: 时间戳,范围为1000000000000到9999999999999。 默认取值: 不涉及 最小值:1000000000000 最大值:9999999999999 |
start_update_time |
否 |
Long |
参数解释: 最小更新时间。 约束限制: 不涉及 取值范围: 时间戳,范围为1000000000000到9999999999999。 默认取值: 不涉及 最小值:1000000000000 最大值:9999999999999 |
end_update_time |
否 |
Long |
参数解释: 最大更新时间。 约束限制: 不涉及 取值范围: 时间戳,范围为1000000000000到9999999999999。 默认取值: 不涉及 最小值:1000000000000 最大值:9999999999999 |
sort_by |
否 |
String |
参数解释: 排序规则,目前默认时间降序,支持根据create_time|update_time排序。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
sort_dir |
否 |
String |
参数解释: 排序规则,目前默认时间降序。 约束限制: 不涉及 取值范围:
默认取值: DESC 缺省值:DESC |
limit |
否 |
Integer |
参数解释: 限制量,单次查询总量。 约束限制: 不涉及 取值范围: 必须由数字组成,取值范围[1,1000]。 默认取值: 100 最小值:1 最大值:1000 缺省值:100 |
offset |
否 |
Integer |
参数解释: 偏移量,查询起始偏移。 约束限制: 不涉及 取值范围: 必须由数字组成,取值范围[0,100000000]。 默认取值: 0 最小值:0 最大值:100000000 缺省值:0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
获取用户所属空间的镜像列表。
https://{endpoint}/v1/{project_id}/eihealth-projects/images
响应示例
状态码:200
OK
{ "count" : 1, "images" : [ { "name" : "demoimage", "id" : "d4fc37ee-831d-4f64-afca-e2fd05f0824d", "type" : "APP", "chip_type" : "X86", "description" : "description", "eihealth_project_id" : "85249b45-9fd6-46c7-aa9c-7437b237c852", "eihealth_project_name" : "project-name", "tags" : [ "v1.1" ], "user_name" : "user_name", "user_id" : "user_id", "create_type" : "PLATFORM_CREATED", "create_time" : "2021-01-21T10:54:06Z", "update_time" : "2021-01-21T10:54:06Z", "source_project_id" : "d57g37ee-831d-4f64-afca-e2fd05f0824d", "source_project_name" : "demo-project", "source_resource_id" : "5f40782b-3804-4684-a009-253265dd4592" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。