查看自定义镜像版本列表 - ListV2ImageVersions

功能介绍

查看自定义镜像版本列表。用户可查询指定镜像下的所有版本信息。此接口为同步接口，无配套使用接口和特殊场景。

调用方法

URI

GET /v2/workspaces/{workspace_id}/images/{image_id}/versions

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

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	参数解释：分页大小。约束限制：不涉及。取值范围：1~1000。默认取值：100。
offset	否	Integer	参数解释：分页偏移量。约束限制：不涉及。取值范围：0~10000。默认取值：0。
version	否	String	参数解释：镜像版本名称（TAG）。约束限制：不涉及。取值范围：长度为1~128的英文字符、数字、中划线、点和下划线的组合。默认取值：不涉及。
type	否	String	参数解释：镜像版本类型筛选。约束限制：不涉及。取值范围： STABLE：稳定版本。 RECOMMEND：推荐版本。 BETA：测试版本。默认取值：不涉及
architectures	否	String	参数解释：镜像架构筛选，多个架构用逗号分隔。约束限制：不涉及。取值范围： x86_64：x86架构。 aarch64：ARM架构。默认取值：不涉及
sort_by	否	String	参数解释：指定排序字段。约束限制：不涉及。取值范围： CREATE_TIME：创建时间，默认值。 UPDATE_TIME：更新时间。默认取值：不涉及。
order_by	否	String	参数解释：排序方式。约束限制：不涉及。取值范围： ASC：递增排序。 DESC：递减排序。默认取值：DESC。

请求参数

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

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
total	Integer	参数解释：总记录数。取值范围：最小值为0，最大值为100000。
image_versions	Array of V2ImageVersionInfo objects	参数解释：镜像版本列表。

表5 V2ImageVersionInfo
参数	参数类型	描述
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个字符。

状态码：500

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

请求示例

查询某镜像下所有版本信息。

GET /v2/workspaces/{workspace_id}/images/{image_id}/versions

响应示例

状态码：200

请求成功。

{
  "total" : 1,
  "image_versions" : [ {
    "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."
}

状态码：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."
}