文档首页/ 智能数据湖 AI DataLake/ API参考/ 租户镜像管理/ 更新自定义镜像版本 - UpdateV2TenantImageVersion

更新时间：2026-10-19 GMT+08:00

更新自定义镜像版本 - UpdateV2TenantImageVersion

功能介绍

更新自定义镜像版本信息。用户通过该接口更新指定镜像版本的描述、架构、容器软件、分类等信息。此接口为同步接口，与注册自定义镜像接口配合完成镜像版本管理。

调用方法

URI

PUT /v2/images/{image_id}/versions/{version_id}

表1 路径参数
参数	是否必选	参数类型	描述
image_id	是	String	参数解释：镜像ID。可通过查询自定义镜像列表获取镜像ID。约束限制：不涉及。取值范围：长度为32~36的英文字符、数字和中划线的组合。默认取值：不涉及。
version_id	是	String	参数解释：镜像版本ID。可通过查询自定义镜像版本列表获取镜像版本ID。约束限制：不涉及。取值范围：长度为32~36的英文字符、数字和中划线的组合。默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token，通过调用获取IAM用户Token接口获取。约束限制：不涉及。取值范围：只能由英文字母、数字及特殊字符组成，长度不超过65534个字符。Token格式由IAM服务定义，具体字符集参见IAM服务相关文档。默认取值：不涉及。

表3 请求Body参数
参数	是否必选	参数类型	描述
description	否	String	参数解释：自定义镜像的描述。约束限制：不涉及。取值范围：不允许输入感叹号、小于号、大于号、等号、与号、双引号、单引号、艾特符、井号、百分号、分号、左括号、右括号、竖线、星号、反斜杠。长度为0~2000个字符。默认取值：不涉及。
architectures	否	Array of strings	参数解释：支持镜像架构列表，取值包括：x86_64（x86架构）、aarch64（ARM架构），未传入该参数时默认为x86_64。约束限制：不涉及。
type	否	String	参数解释：镜像版本类型。约束限制：不涉及。取值范围： STABLE：稳定版本。 RECOMMEND：推荐版本。 BETA：测试版本。默认取值：不涉及。
container_softwares	否	Array of ContainerSoftware objects	参数解释：自定义镜像包含的软件列表，每个元素为一个ContainerSoftware对象，包含软件名称和版本信息，软件列表最小个数为0，最大个数为100。约束限制：不涉及。
category	否	String	参数解释：自定义镜像分类。约束限制：不涉及。取值范围： RAY_BASIC：基于Ray构建的自定义镜像。 SPARK_JOB：基于SparkJob构建的自定义镜像。 SPARK_SQL：基于SparkSql构建的自定义镜像。 FLINK_JOB：基于FlinkJob构建的自定义镜像。 AURA_JOB：基于AuraJobV2构建的自定义镜像。默认取值：不涉及。

表4 ContainerSoftware
参数	是否必选	参数类型	描述
name	是	String	参数解释：软件名称。约束限制：不涉及。取值范围：支持英文字母、数字、小数点、下划线和连字符，2~32个字符。默认取值：不涉及。
version	是	String	参数解释：软件版本。约束限制：不涉及。取值范围：支持英文字母、数字、小数点、下划线和连字符，2~32个字符。默认取值：不涉及。

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
version_id	String	参数解释：镜像版本ID。取值范围：长度为32~36的英文字符、数字和中划线的组合。
image_version	String	参数解释：镜像版本。取值范围：支持英文字母、数字、小数点、斜杠、冒号、下划线和连字符，长度2~32个字符。
category	String	参数解释：镜像分类。取值范围： RAY_BASIC：基于Ray构建的自定义镜像。 SPARK_JOB：基于SparkJob构建的自定义镜像。 SPARK_SQL：基于SparkSql构建的自定义镜像。 FLINK_JOB：基于FlinkJob构建的自定义镜像。 AURA_JOB：基于AuraJobV2构建的自定义镜像。
image_registry	String	参数解释：镜像域名。取值范围：支持英文字母、数字、小数点及连字符，长度0~255个字符。
image_namespace	String	参数解释：镜像命名空间。取值范围：由英文字母、数字、中划线和下划线组成，长度0~64个字符。
image_name	String	参数解释：镜像名。取值范围：由中文字符、英文字母、数字、中划线和下划线组成，长度0~128个字符。
architectures	Array of strings	参数解释：镜像支持的架构列表，取值包括：x86_64（x86架构）、aarch64（ARM架构）。
container_softwares	Array of ContainerSoftware objects	参数解释：镜像软件列表，每个元素为一个ContainerSoftware对象，包含软件名称和版本信息。
status	String	参数解释：镜像版本状态。取值范围： AVAILABLE：可用。 UNAVAILABLE：不可用。 UNKNOWN：未知。
type	String	参数解释：镜像版本类型。取值范围： STABLE：稳定版本。 RECOMMEND：推荐版本。 BETA：测试版本。
visibility	String	参数解释：镜像版本可见性。取值范围： PRIVATE：私有，仅工作空间内可见。 PUBLIC：公共，所有工作空间可见。
create_time	String	参数解释：自定义镜像版本创建时间，使用UTC时间，ISO 8601格式，yyyy-MM-dd'T'HH:mm:ss.SSSXXX，例如：2025-01-10T03:37:12.000+00:00。取值范围：不涉及。
update_time	String	参数解释：自定义镜像版本更新时间，使用UTC时间，ISO 8601格式，yyyy-MM-dd'T'HH:mm:ss.SSSXXX，例如：2025-01-10T03:37:12.000+00:00。取值范围：不涉及。
description	String	参数解释：镜像版本描述。取值范围：支持中文字符、英文字母、数字及常用符号（不允许输入感叹号、小于号、大于号、等号、与号、双引号、单引号），长度0~2000个字符。
base_image_id	String	参数解释：关联的预置基础镜像ID。取值范围：支持英文字母、数字及中划线，长度0~64个字符。
base_image_version_id	String	参数解释：关联的预置基础镜像版本ID。取值范围：支持英文字母、数字及中划线，长度0~64个字符。
image_snapshot	V2ImageSnapshotInfo object	参数解释：匹配到的镜像快照信息，无快照时为null。

表6 ContainerSoftware
参数	参数类型	描述
name	String	参数解释：软件名称。取值范围：支持英文字母、数字、小数点、下划线和连字符，2~32个字符。
version	String	参数解释：软件版本。取值范围：支持英文字母、数字、小数点、下划线和连字符，2~32个字符。

表7 V2ImageSnapshotInfo
参数	参数类型	描述
id	String	参数解释：镜像快照记录ID。取值范围：长度为32~36的英文字符、数字和中划线的组合。
image_id	String	参数解释：镜像ID。取值范围：长度为32~36的英文字符、数字和中划线的组合。
image_version_id	String	参数解释：镜像版本ID。取值范围：长度为32~36的英文字符、数字和中划线的组合。
name	String	参数解释：镜像快照名称（用户指定）。取值范围：以小写字母开头，小写字母、数字、中划线（-）组成，小写字母或数字结尾的1到190字符的字符串。
image_address	String	参数解释：镜像完整地址（含registry/namespace/name:version）。取值范围：支持英文字母、数字、小数点、冒号、斜杠及连字符，长度为0~1024个字符。
image_name	String	参数解释：镜像名称。取值范围：支持英文字母、数字、小数点、斜杠、冒号、下划线和连字符，长度为0~128个字符。
image_version	String	参数解释：镜像版本。取值范围：支持英文字母、数字、小数点、冒号、下划线和连字符，长度为0~1024个字符。
status	String	参数解释：镜像快照状态。取值范围： Creating：创建中。 Available：可用。 Unavailable：不可用。
image_snapshot_size	Integer	参数解释：快照大小，单位GiB。取值范围：20~400。
creation_mode	String	参数解释：创建方式。取值范围： Created：直接创建。 Associated：关联CCI已有快照。
reserved_days	Integer	参数解释：镜像快照保留天数。超过保留天数自动失效，0表示永久保留。取值范围：0~65536。
expire_time	String	参数解释：镜像快照超期时间，null表示永久有效。使用UTC时间，ISO 8601格式，yyyy-MM-dd'T'HH:mm:ss.SSSXXX，例如：2025-01-10T03:37:12.000+00:00。取值范围：不涉及。
failed_message	String	参数解释：镜像快照失效的提示信息。取值范围：支持中文字符、英文字母、数字及常用符号，长度为0~65535个字符。
create_time	String	参数解释：创建时间，使用UTC时间，ISO 8601格式，yyyy-MM-dd'T'HH:mm:ss.SSSXXX，例如：2025-01-10T03:37:12.000+00:00。取值范围：不涉及。
update_time	String	参数解释：更新时间，使用UTC时间，ISO 8601格式，yyyy-MM-dd'T'HH:mm:ss.SSSXXX，例如：2025-01-10T03:37:12.000+00:00。取值范围：不涉及。

状态码：400

表8 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~512个字符。
solution_msg	String	参数解释：解决方案。取值范围：长度为0~4096个字符。

状态码：401

表9 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~512个字符。
solution_msg	String	参数解释：解决方案。取值范围：长度为0~4096个字符。

状态码：403

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~512个字符。
solution_msg	String	参数解释：解决方案。取值范围：长度为0~4096个字符。

状态码：404

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~512个字符。
solution_msg	String	参数解释：解决方案。取值范围：长度为0~4096个字符。

状态码：408

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~512个字符。
solution_msg	String	参数解释：解决方案。取值范围：长度为0~4096个字符。

状态码：500

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~512个字符。
solution_msg	String	参数解释：解决方案。取值范围：长度为0~4096个字符。

请求示例

修改自定义镜像版本描述为“Updated Ray image”。

PUT /v2/images/{image_id}/versions/{version_id}

{
  "architectures" : [ "x86_64" ],
  "container_softwares" : [ {
    "name" : "jdk",
    "version" : "21"
  } ],
  "description" : "Updated Ray image"
}

响应示例