文档首页/ 魔坊（ModelArts）模型训推平台/ API参考/ 开发环境/ 开发环境管理/ 更新镜像组 - UpdateImageGroup
更新时间：2026-07-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新镜像组 - UpdateImageGroup

功能介绍

更新镜像组接口用于更新镜像组的标签及说明信息。该接口适用于以下场景：当镜像说明需要修改，或者镜像的标签需要修改时，用户可通过此接口修改。使用该接口的前提条件是镜像组已存在且用户具有更新权限。更新操作完成后，镜像组对应的配置文件会。若镜像组不存在、用户无权限操作或镜像正在被使用，接口将返回相应的错误信息。

接口约束

暂无约束。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

PUT /v1/{project_id}/images/group/{id}

表1 路径参数

参数

是否必选

参数类型

描述

id

是

String

参数解释：镜像组ID，ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

project_id

是

String

参数解释：用户项目ID，获取方法请参见获取项目ID和名称。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

read_me

否

String

参数解释：镜像组更新的概览信息。

约束限制：不涉及。

取值范围：长度限制30000个字符。

默认取值：不涉及。

tags

否

Array of tags objects

参数解释：镜像组更新的标签。

约束限制：最大支持20个标签。

取值范围：key值最大支持长度128，value值最大支持255。

默认取值：不涉及。
表3 tags

参数

是否必选

参数类型

描述

key

否

String

参数解释：标签键

约束限制：最大支持20个标签键。

取值范围：key值最大支持长度128

默认取值：null。

value

否

String

参数解释：标签值

约束限制：最大支持20个标签值。

取值范围：value值最大支持长度255

默认取值：null。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

name

String

参数解释：镜像名称。

取值范围：不涉及。

create_at

Long

参数解释：镜像创建的时间，单位：UTC毫秒。

取值范围：不涉及。

namespace

String

参数解释：镜像所属的SWR组织。

取值范围：不涉及。

update_at

Long

参数解释：镜像最后更新的时间，单位：UTC毫秒。

取值范围：不涉及。

version_count

Integer

参数解释：镜像版本个数。

取值范围：不涉及。

description

String

参数解释：镜像描述信息。

取值范围：不涉及。

read_me

String

参数解释：镜像指导信息。

取值范围：不涉及。

icon_name

String

参数解释：镜像图标名称。

取值范围：不涉及。

id

String

参数解释：镜像id。

取值范围：不涉及。

swr_instance_id

String

参数解释：SWR企业仓库ID。未使用SWR企业仓时该字段为null。

约束限制：限制长度128。

取值范围：0-128的0-9和a-z。

默认取值：不涉及。

swr_instance_name

String

参数解释：SWR企业版镜像仓库名称。

约束限制：3-48个字符。

取值范围：3-48个字符。

默认取值：不涉及。

状态码：204

No Content。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

参数解释：具体错误信息。

取值范围：不涉及。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

参数解释：具体错误信息。

取值范围：不涉及。

请求示例

更新镜像组的标签及概览信息

PUT https://{endpoint}/v1/{project_id}/images/group/{id}

{
  "read_me" : "read_me_test",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  } ]
}

响应示例

状态码：200

OK。

{
  "create_at" : 1773668206040,
  "description" : "custome_image",
  "icon_name" : "Docker",
  "id" : "0679184a-c22a-4326-b94d-011224ada4a4",
  "name" : "pytorch",
  "namespace" : "image_dev",
  "read_me" : "read_me_test",
  "update_at" : 1773668206040,
  "version_count" : 1
}

状态码

状态码

描述

200

OK。

204

No Content。

401

Unauthorized。

403

Forbidden。

错误码

请参见错误码。

父主题： 开发环境管理