# 通过运行的实例保存成容器镜像 - CreateImage #### 功能介绍 通过运行的实例保存成容器镜像接口用于将正在运行的实例保存为容器镜像。该接口适用于以下场景：用户需要保存当前运行环境以便后续使用或开发时，可通过此接口将实例保存为镜像。使用该接口的前提条件是用户已登录系统并具有访问目标实例的权限，同时实例必须处于运行状态。调用该接口后，系统将保存实例的当前状态为容器镜像，包括安装的依赖包和插件。若用户无权限访问指定实例或实例未运行，接口将返回相应的错误信息。 #### 接口约束 暂无约束。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=CreateImage)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:image:create | Write | image \* | - | - | - | | modelarts:image:create | Write | - | g:EnterpriseProjectId | - | - | #### URI POST /v1/{project_id}/notebooks/{id}/create-image 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释** ：Notebook实例ID。ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID），可通过调用[查询Notebook实例列表接口](https://support.huaweicloud.com/api-modelarts/ListNotebooks.html#section0)获取。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | project_id | 是 | String | **参数解释** ：用户项目ID，获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | description | 否 | String | **参数解释**：该镜像所对应的描述信息。 **约束限制**：不涉及。 **取值范围**：长度限制512个字符。 **默认取值**：不涉及。 | | name | 是 | String | **参数解释**：镜像名称。 **约束限制**：不涉及。 **取值范围**：长度限制为128个字符，支持小写字母、数字、中划线、下划线和点，字符串必须以小写字母或数字开头和结尾。 **默认取值**：不涉及。 | | namespace | 是 | String | **参数解释**：镜像所属组织，可以在SWR控制台"组织管理"创建和查看。 **约束限制**：不涉及。 **取值范围**：长度限制为64个字符，支持大小写字母、数字、中划线、下划线和点号，且必须是小写字母开头。 **默认取值**：不涉及。 | | tag | 否 | String | **参数解释**：镜像tag。 **约束限制**：不涉及。 **取值范围**：长度限制64个字符，支持大小写字母、数字、中划线、下划线和点号。 **默认取值**：不涉及。 | | workspace_id | 否 | String | **参数解释** ：工作空间ID。获取方法请参见[查询工作空间列表](https://support.huaweicloud.com/api-modelarts/ListWorkspace.html#ZH-CN_TOPIC_0000002723741766)。未创建工作空间时默认值为"0"，存在创建并使用的工作空间，以实际取值为准。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：0。 | | swr_instance_id | 否 | String | **参数解释**：企业版SWR仓库ID。 **参数约束**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | swr_instance_domain | 否 | String | **参数解释**：企业版SWR仓库域名。 **参数约束**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 响应参数 **状态码：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参考[查询支持的镜像列表](https://support.huaweicloud.com/api-modelarts/ListImage.html#ZH-CN_TOPIC_0000002753341545)获取。 **取值范围**：不涉及。 | | 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：昇腾910芯片。 - ASCEND_SNT9B：昇腾910B芯片。 - ASCEND_SNT3：昇腾310芯片。 | | swr_instance_id | String | **参数解释**：企业版SWR仓库ID。 **取值范围**：不涉及。 | | show_tag | String | **参数解释**：镜像展示Tag。 **取值范围**：不涉及。 | | show_name | String | **参数解释**：镜像展示name。 **取值范围**：不涉及。 | | tags | Array of [TmsTagResponse] objects | **参数解释**：镜像标签。 | 表4TmsTagResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**：TMS标签的key。 **取值范围**：不涉及。 | | value | String | **参数解释**：TMS标签的value。 **取值范围**：不涉及。 | **状态码：201** Created。 #### 请求示例 将运行的实例可以保存成容器镜像。设置镜像名称为"pytorch1_4"，镜像所属组织为"atelier-auto"。 ``` { "name" : "pytorch1_4", "namespace" : "atelier-auto", "tag" : "20221223", "description" : "save from notebook-x21d", "workspace_id" : "0" } ``` #### 响应示例 **状态码：200** ``` { "arch" : "x86_64", "create_at" : 1671786468811, "description" : "notebook2.0 20200816", "dev_services" : [ "SSH", "NOTEBOOK" ], "id" : "4e0d1854-63e5-4517-b683-a0ee97a692a1", "name" : "pytorch1_4", "namespace" : "atelier-auto", "origin" : "IMAGE_SAVE", "resource_categories" : [ "CPU", "GPU" ], "service_type" : "TRAIN", "status" : "INIT", "swr_path" : "swr.xxxxx.com/atelier-auto/pytorch1_4:20221223", "tag" : "20221223", "type" : "DEDICATED", "update_at" : 1671786468811, "visibility" : "PRIVATE", "workspace_id" : "0" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK。 | | 201 | Created。 | | 401 | Unauthorized。 | | 403 | Forbidden。 | | 404 | Not Found。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。