查询镜像详情 - ShowV2Image

功能介绍

查询指定镜像的详细信息。用户可通过该接口获取单个镜像的完整配置和元数据。此接口为同步接口，无配套使用接口和特殊场景。

调用方法

URI

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

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

请求参数

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

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
id	String	参数解释：镜像ID。取值范围：长度为32~36的英文字符、数字和中划线的组合。
image_name	String	参数解释：镜像名。取值范围：字符串，长度0~128个字符。
category	String	参数解释：镜像分类。取值范围：字符串，长度0~32个字符。
image_registry	String	参数解释：镜像域名。取值范围：字符串，长度0~255个字符。
image_namespace	String	参数解释：镜像命名空间。取值范围：字符串，长度0~64个字符。
version_count	Integer	参数解释：镜像版本数量。取值范围：不涉及。
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。
visibility	String	参数解释：可见性。取值范围： PRIVATE：私有。 PUBLIC：公共。
description	String	参数解释：描述。取值范围：字符串，长度0~2000个字符。
instruction	String	参数解释：公共镜像使用说明。取值范围：字符串，长度0~20000个字符。

状态码：400

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

状态码：401

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

状态码：403

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

状态码：404

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

状态码：500

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

请求示例

查询指定镜像的详细信息。用于获取单个镜像的完整配置和元数据。

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

响应示例

状态码：200

请求成功。

{
  "id" : "90a827a1-ca72-4be8-943b-774f945f22ac",
  "image_name" : "test-image",
  "category" : "RAY_BASIC",
  "image_registry" : "swr.cn-north-4.myhuaweicloud.com",
  "image_namespace" : "test-namespace",
  "version_count" : 3,
  "create_time" : "2025-01-10T03:37:12.000+00:00",
  "update_time" : "2025-01-11T03:37:12.000+00:00",
  "visibility" : "PRIVATE",
  "description" : "test image"
}

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

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