更新自定义镜像版本 - UpdateV2ImageVersion

功能介绍

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

调用方法

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
workspace_id	是	String	参数解释：工作空间ID。取值范围：长度为32~36的英文字符、数字和中划线的组合。
image_id	是	String	参数解释：镜像ID。约束限制：不涉及。取值范围：长度为32~36的英文字符、数字和中划线的组合。默认取值：不涉及。
version_id	是	String	参数解释：镜像版本ID。约束限制：不涉及。取值范围：长度为32~36的英文字符、数字和中划线的组合。默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。约束限制：不涉及。取值范围：长度不超过65534个字符。默认取值：不涉及。

表3 请求Body参数
参数	是否必选	参数类型	描述
description	否	String	参数解释：自定义镜像的描述。约束限制：选填。取值范围：字符串，长度0~500个字符。默认取值：不涉及。
architectures	否	Array of strings	参数解释：支持架构列表。约束限制：不涉及。取值范围： x86_64：x86架构。 aarch64：ARM架构。默认取值：x86_64。
type	否	String	参数解释：镜像版本类型。约束限制：选填。取值范围： STABLE：稳定版本。 RECOMMEND：推荐版本。 BETA：测试版本。
container_softwares	否	Array of ContainerSoftware objects	参数解释：自定义镜像包含的软件。约束限制：选填。取值范围：最小个数为0，最大个数为100。
category	否	String	参数解释：自定义镜像分类。约束限制：选填。取值范围： RAY_BASIC：基于Ray构建的自定义镜像。 SPARK_JOB：基于SparkJob构建的自定义镜像。 SPARK_SQL：基于SparkSql构建的自定义镜像。 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	参数解释：镜像分类。取值范围：字符串，长度0~32个字符。
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	参数解释：镜像软件。取值范围：最小个数为0，最大个数为100。
status	String	参数解释：状态。取值范围： AVAILABLE：可用。 UNAVAILABLE：不可用。 UNKNOWN：未知。
type	String	参数解释：镜像版本类型。取值范围： STABLE：稳定版本。 RECOMMEND：推荐版本。 BETA：测试版本。
visibility	String	参数解释：可见性。取值范围： PRIVATE：私有，仅工作空间内可见。 PUBLIC：公共，所有工作空间可见。
create_time	String	参数解释：创建时间。取值范围：ISO 8601格式，yyyy-MM-dd'T'HH:mm:ss.SSSZ。
update_time	String	参数解释：更新时间。取值范围：ISO 8601格式，yyyy-MM-dd'T'HH:mm:ss.SSSZ。
description	String	参数解释：镜像描述。取值范围：字符串，长度0~2000个字符。

表6 ContainerSoftware
参数	参数类型	描述
name	String	参数解释：软件名称。取值范围：字符串，2~32个字符。
version	String	参数解释：软件版本。取值范围：字符串，2~32个字符。

状态码：400

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

状态码：401

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

状态码：403

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

状态码：404

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

状态码：408

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

状态码：500

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

请求示例

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

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

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

响应示例

状态码：200

请求成功。

{
  "version_id" : "8f3a2b1c4d5e6f7a8b9c0d1e2f3a4b5c",
  "category" : "AURA_JOB",
  "architectures" : [ "x86_64" ],
  "container_softwares" : [ {
    "name" : "jdk",
    "version" : "21"
  } ],
  "image_registry" : "swr.cn-north-4.myhuaweicloud.com",
  "image_namespace" : "test-namespace",
  "image_name" : "test-image",
  "image_version" : "v1.0.0",
  "status" : "AVAILABLE",
  "type" : "STABLE",
  "visibility" : "PRIVATE",
  "create_time" : "2025-01-10T03:37:12.000+00:00",
  "update_time" : "2025-01-10T03:37:12.000+00:00",
  "description" : "更新后的镜像版本描述"
}

状态码：400

请求参数错误。

{
  "error_code" : "AIDataLake.00010011",
  "error_msg" : "Invalid specification code.",
  "solution_msg" : "Enter a correct specification code."
}

状态码：401

未授权。

{
  "error_code" : "APIGW.0301",
  "error_msg" : "Incorrect IAM authentication information decrypt token fail"
}

状态码：403

禁止访问。

{
  "error_code" : "AIDataLake.00010038",
  "error_msg" : "Unauthorized requests.",
  "solution_msg" : "Check permissions {xxx} and retry after authorization."
}

状态码：404

资源未找到。

{
  "error_code" : "AIDataLake.00010004",
  "error_msg" : "Not Found",
  "solution_msg" : "Please check the resource ID and try again"
}

状态码：408

请求超时。

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

内部服务器错误。

{
  "error_code" : "AIDataLake.00010067",
  "error_msg" : "Failed to initialize the task because the number of tasks may have reached the upper limit.",
  "solution_msg" : "Try again later."
}