文档首页/ 智能数据湖 AI DataLake/ API参考/ 租户镜像管理/ 查询镜像详情 - ShowV2TenantImage
更新时间：2026-10-19 GMT+08:00
查看PDF
分享

查询镜像详情 - ShowV2TenantImage

功能介绍

查询指定镜像的详细信息。此接口为同步接口，无配套使用接口和特殊场景。

调用方法

请参见如何调用API。

URI

GET /v2/images/{image_id}

表1 路径参数

参数

是否必选

参数类型

描述

image_id

是

String

参数解释：镜像ID。可通过查询自定义镜像列表获取镜像ID。

约束限制：不涉及。

取值范围：长度为32~36的英文字符、数字和中划线的组合。

默认取值：不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：用户Token，通过调用获取IAM用户Token接口获取。

约束限制：不涉及。

取值范围：只能由英文字母、数字及特殊字符组成，长度不超过65534个字符。Token格式由IAM服务定义，具体字符集参见IAM服务相关文档。

默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释：镜像ID。

取值范围：长度为32~36的英文字符、数字和中划线的组合。

image_name

String

参数解释：镜像名。

取值范围：由中文字符、英文字母、数字、中划线和下划线组成，长度0~128个字符。

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个字符。

version_count

Integer

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

取值范围：大于等于0。

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。

取值范围：不涉及。

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/images/{image_id}

响应示例

状态码：200

{
  "id" : "90a827a1-ca72-4f3a-9e2d-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.00010151",
  "error_msg" : "Parameter value is invalid.",
  "solution_msg" : "Please input valid parameter value."
}

状态码：401

{
  "error_code" : "APIGW.0301",
  "error_msg" : "Incorrect IAM authentication information: decrypt token fail.",
  "solution_msg" : "Check whether the IAM authentication information is correct."
}

状态码：403

{
  "error_code" : "AIDataLake.00010150",
  "error_msg" : "The operation is not allowed.",
  "solution_msg" : "Check whether the operation is allowed in the current status."
}

状态码：404

{
  "error_code" : "AIDataLake.00010288",
  "error_msg" : "The image not exist, image ID: 571d13c6-54a8-470b-aaa2-20c29c362169.",
  "solution_msg" : "Please check whether the image is correct."
}

状态码：500

{
  "error_code" : "AIDataLake.00011001",
  "error_msg" : "Internal error.",
  "solution_msg" : "Contact technical support or try again later."
}

状态码

状态码

描述

200

请求成功。

400

请求参数错误。

401

未授权。

403

禁止访问。

404

资源未找到。

500

内部服务器错误。
父主题： 租户镜像管理

相关文档