查询用户镜像列表 - ListImageGroup
功能介绍
查询用户镜像列表接口用于查询用户镜像信息概览,以镜像名称作为聚合的信息。该接口适用于以下场景:当用户需要管理多个镜像或了解各镜像的基本信息时,可通过此接口获取镜像列表及其概览信息。使用该接口的前提条件是用户具备镜像管理权限,并且镜像已存在。查询操作完成后,将返回用户所有镜像的列表,包括镜像名称、版本、状态等信息。若镜像不存在或用户无权限访问,接口将返回相应的错误信息。
接口约束
暂无约束。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
modelarts:image:listGroup
List
image *
-
-
-
URI
GET /v1/{project_id}/images/group
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释:用户项目ID,获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
name | 否 | String | 参数解释:镜像名称。 约束限制:不涉及。 取值范围:长度限制为512个字符,支持小写字母、数字、中划线、下划线和点。 默认取值:不涉及。 |
name_fuzzy_match | 否 | Boolean | 参数解释:镜像名称是否模糊匹配查询。 约束限制:不涉及。 取值范围:布尔类型: 默认取值:true。 |
namespace | 否 | String | 参数解释:镜像所属组织,可以在SWR控制台“组织管理”创建和查看。 约束限制:不涉及。 取值范围:长度限制为64个字符,支持大小写字母、数字、中划线、下划线和点号,且必须是小写字母开头。 默认取值:不涉及。 |
type | 否 | String | 参数解释:镜像类型。 约束限制:不涉及。 取值范围:枚举类型,取值如下: 默认取值:不涉及。 |
workspace_id | 否 | String | 参数解释:工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。 约束限制:不涉及。 取值范围:0或32位仅包含字符0-9或小写字母a-z的字符串。 默认取值:0。 |
limit | 否 | Integer | 参数解释:每一页显示的镜像实例数量。 约束限制:不涉及。 取值范围:正整数。 默认取值:200。 |
offset | 否 | Integer | 参数解释:分页记录的起始位置偏移量。 约束限制:不涉及。 取值范围:非负整数。 默认取值:0。 |
swr_instance_id | 否 | String | 参数解释:企业版SWR仓库ID。 参数约束:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
current | Integer | 参数解释:当前页数。 取值范围:正整数。 |
data | Array of ImageGroup objects | 参数解释:镜像信息概览数据。 |
pages | Integer | 参数解释:总的页数。 取值范围:正整数。 |
size | Integer | 参数解释:每一页的数量。 取值范围:正整数。 |
total | Long | 参数解释:总的记录数量。 取值范围:非负整数。 |
参数 | 参数类型 | 描述 |
|---|---|---|
name | String | 参数解释:镜像名称。 取值范围:不涉及。 |
create_at | Long | 参数解释:镜像创建的时间,单位:UTC毫秒。 取值范围:不涉及。 |
namespace | String | 参数解释:镜像所属的SWR组织。 取值范围:不涉及。 |
update_at | Long | 参数解释:镜像最后更新的时间,单位:UTC毫秒。 取值范围:不涉及。 |
version_count | Integer | 参数解释:镜像版本个数。 取值范围:不涉及。 |
description | String | 参数解释:镜像描述信息。 取值范围:不涉及。 |
read_me | String | 参数解释:镜像指导。 取值范围:不涉及。 |
icon_name | String | 参数解释:镜像图标名称。 取值范围:不涉及。 |
swr_instance_name | String | 参数解释:SWR企业版镜像仓库名称。 取值范围:不涉及。 |
swr_instance_id | String | 参数解释:SWR企业版镜像仓库ID。 取值范围:不涉及。 |
请求示例
GET https://{endpoint}/v1/{project_id}/images/group 响应示例
状态码:200
OK。
{
"current" : 1,
"data" : [ {
"create_at" : 1652878011643,
"name" : "123",
"namespace" : "cnnorth7-infer-model-dev",
"update_at" : 1652878531791,
"version_count" : 1
}, {
"create_at" : 1671708630448,
"name" : "pytorch_1_8",
"namespace" : "op_svc_modelarts_container2",
"update_at" : 1671708630448,
"version_count" : 1
}, {
"create_at" : 1671093486722,
"name" : "mock-service-python",
"namespace" : "mock-service1",
"update_at" : 1671093486722,
"version_count" : 1
} ],
"pages" : 1,
"size" : 3,
"total" : 3
} 状态码
状态码 | 描述 |
|---|---|
200 | OK。 |
401 | Unauthorized。 |
403 | Forbidden。 |
404 | Not Found。 |
错误码
请参见错误码。

