文档首页/ AI开发平台ModelArts/ API参考/ 开发环境管理/ 注册自定义镜像
更新时间：2025-08-19 GMT+08:00
查看PDF
分享

注册自定义镜像

功能介绍

注册自定义镜像接口用于将用户自定义的镜像注册到ModelArts镜像管理。该接口适用于以下场景：当用户需要将自己的自定义镜像（如特定算法环境、工具链或配置）集成到ModelArts平台时，可通过此接口将镜像注册到镜像管理中以便后续使用。使用该接口的前提条件是用户具备ModelArts镜像管理权限，并且需要提供有效的镜像地址和符合要求的镜像格式。注册操作完成后，自定义镜像将被成功添加到ModelArts镜像列表中，用户可以在后续任务中选择使用该镜像。若镜像地址无效、镜像格式不符合要求或用户无权限操作，接口将返回相应的错误信息。

接口约束

暂无约束。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/images

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：用户项目ID，获取方法请参见获取项目ID和名称。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

arch

否

String

参数解释：该镜像所支持处理器架构类型。

约束限制：不涉及。

取值范围：枚举类型，取值如下：

  • X86_64：x86处理器架构。

  • AARCH64：ARM体系架构。

默认取值：X86_64。

description

否

String

参数解释：该镜像所对应的描述信息。

约束限制：不涉及。

取值范围：长度限制512个字符。

默认取值：不涉及。

origin

否

String

参数解释：指定镜像来源，可选项。

约束限制：不涉及。

取值范围：枚举类型，取值如下：

  • CUSTOMIZE: 用户自定义构建镜像。

  • IMAGE_SAVE：Notebook实例保存镜像。

默认取值：CUSTOMIZE。

resource_category

否

Array of strings

参数解释：镜像支持的规格，默认值CPU、GPU。 枚举值如下：

  • CPU

  • GPU

  • ASCEND。

约束限制：不涉及。

service_type

否

String

参数解释：镜像支持服务类型。

约束限制：不涉及。

取值范围：枚举类型，取值如下：

  • COMMON：通用镜像。

  • INFERENCE: 建议仅在推理部署场景使用。

  • TRAIN: 建议仅在训练任务场景使用。

  • DEV: 建议仅在开发调测场景使用。

  • UNKNOWN: 未明确设置的镜像支持的服务类型。

默认取值：UNKNOWN。

services

否

Array of strings

参数解释：镜像支持的服务，默认值NOTEBOOK、SSH。枚举值如下:

  • NOTEBOOK：镜像支持通过https协议访问Notebook。

  • SSH：镜像支持本地IDE通过SSH协议远程连接Notebook。

约束限制：不涉及。

swr_path

是

String

参数解释：SWR镜像地址。

约束限制：不涉及。

取值范围：长度最长为2048个字符，最短为16个字符，地址格式为：[仓库地址[:端口]]/[命名空间]/[镜像名称]:[标签]。

默认取值：不涉及。

visibility

否

String

参数解释：镜像可见度。

约束限制：不涉及。

取值范围：枚举类型，取值如下：

  • PRIVATE：私有镜像。

  • PUBLIC: 所有用户可以根据image_id来进行只读使用。

默认取值：PRIVATE。

workspace_id

否

String

参数解释：工作空间ID。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

约束限制：不涉及。

取值范围：0或32位仅包含字符0-9或小写字母a-z的字符串。

默认取值：0。

flavor_type

否

String

参数解释：资源类型。

约束限制：不涉及。

取值范围：枚举类型，取值如下：

-ASCEND_SNT9

-ASCEND_SNT9B

-ASCEND_SNT3

默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

arch

String

参数解释：该镜像所支持处理器架构类型。

取值范围：枚举类型，取值如下：

  • X86_64：x86处理器架构。

  • AARCH64：ARM体系架构。

create_at

Long

参数解释：镜像创建的时间，UTC毫秒。

取值范围：不涉及。

description

String

参数解释：该镜像所对应的描述信息。

取值范围：长度限制512个字符。

dev_services

Array of strings

参数解释：镜像支持的服务。

取值范围：枚举类型，取值如下：

  • NOTEBOOK：镜像支持通过https协议访问Notebook。

  • SSH：镜像支持本地IDE通过SSH协议远程连接Notebook。

id

String

参数解释：待创建Notebook实例的镜像，需要指定镜像ID，ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。预置镜像的ID参考查询支持的镜像列表获取。

取值范围：不涉及。

name

String

参数解释：镜像名称。

取值范围：长度限制512个字符，支持小写字母、数字、中划线、下划线和点。

namespace

String

参数解释：镜像所属组织，可以在SWR控制台“组织管理”创建和查看。

取值范围：不涉及。

origin

String

参数解释：指定镜像来源。

取值范围：枚举类型，取值如下：

  • CUSTOMIZE：用户自定义构建镜像。

  • IMAGE_SAVE：Notebook实例保存镜像。

resource_categories

Array of strings

参数解释：镜像支持的规格。枚举类型，取值如下：

  • CPU

  • GPU

  • ASCEND

service_type

String

参数解释：镜像支持服务类型。

取值范围：枚举类型，取值如下：

  • COMMON：通用镜像。

  • INFERENCE：建议仅在推理部署场景使用。

  • TRAIN：建议仅在训练任务场景使用。

  • DEV：建议仅在开发调测场景使用。

  • UNKNOWN：未明确设置的镜像支持的服务类型。

size

Long

参数解释：镜像大小（单位KB）。

取值范围：不涉及。

status

String

参数解释：镜像状态。

取值范围：枚举类型，取值如下：

  • INIT：初始化。

  • CREATING：镜像保存中，此时Notebook不可用。

  • CREATE_FAILED：镜像保存失败。

  • ERROR：错误。

  • DELETED：已删除。

  • ACTIVE：镜像保存成功，保存的镜像可以在SWR控制台查看，同时可以基于保存的镜像创建Notebook实例。

status_message

String

参数解释：镜像保存操作过程中，构建信息展示。

取值范围：不涉及。

support_res_categories

Array of strings

参数解释：镜像支持的规格。 枚举类型，取值如下：

  • CPU

  • GPU

  • ASCEND

swr_path

String

参数解释：SWR镜像地址。

取值范围：不涉及。

tag

String

参数解释：镜像Tag。

取值范围：不涉及。

type

String

参数解释：镜像类型。

取值范围：枚举类型，取值如下：

  • BUILD_IN：系统内置镜像。

  • DEDICATED：用户保存的镜像。

update_at

Long

参数解释：镜像最后更新的时间，UTC毫秒。

取值范围：不涉及。

visibility

String

参数解释：镜像可见度。

取值范围：枚举类型，取值如下：

  • PRIVATE：私有镜像。

  • PUBLIC：所有用户可以根据image_id来进行只读使用。

workspace_id

String

参数解释：工作空间ID。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

取值范围：不涉及。

flavor_type

String

参数解释：镜像的资源类型。

取值范围：枚举类型，取值如下：

  • ASCEND_SNT9

  • ASCEND_SNT9B

  • ASCEND_SNT3

状态码：201

Created。

请求示例

注册自定义镜像。设置镜像支持的规格为“CPU”，支持的处理器架构类型为“X86_64”。

{
  "description" : "",
  "resource_category" : [ "CPU" ],
  "arch" : "X86_64",
  "swr_path" : "swr.xxx.com/op_svc_modelarts_container2/pytorch_1_8:train-pytorch_1.8.0-cuda_10.2-py_3.7"
}

响应示例

状态码：200

OK。

{
  "arch" : "x86_64",
  "create_at" : 1671708630448,
  "description" : "",
  "dev_services" : [ "NOTEBOOK", "SSH" ],
  "id" : "708ca95d-c601-4dc7-86b9-670adfd5e818",
  "name" : "pytorch_1_8",
  "namespace" : "op_svc_modelarts_container2",
  "origin" : "CUSTOMIZE",
  "resource_categories" : [ "CPU" ],
  "service_type" : "UNKNOWN",
  "size" : 3376133259,
  "status" : "ACTIVE",
  "swr_path" : "swr.xxx.com/op_svc_modelarts_container2/pytorch_1_8:train-pytorch_1.8.0-cuda_10.2-py_3.7",
  "tag" : "train-pytorch_1.8.0-cuda_10.2-py_3.7",
  "type" : "DEDICATED",
  "update_at" : 1671708630448,
  "visibility" : "PRIVATE",
  "workspace_id" : "0"
}

状态码

状态码

描述

200

OK。

201

Created。

401

Unauthorized。

403

Forbidden。

404

Not Found。

错误码

请参见错误码。

父主题： 开发环境管理