# 删除镜像 - DeleteImage #### 功能介绍 删除镜像接口用于删除镜像对象，对于个人私有镜像可以通过参数一并删除SWR镜像内容。该接口适用于以下场景：当镜像不再需要、配置错误或需要清理资源时，用户可通过此接口删除指定的镜像对象。使用该接口的前提条件是镜像已存在且用户具有删除权限。删除操作完成后，镜像对象将被永久移除，相关资源和配置也将被清理。若镜像不存在、用户无权限操作或镜像正在被使用，接口将返回相应的错误信息。 #### 接口约束 暂无约束。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=DeleteImage)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:image:delete | Write | image \* | - | - | - | | modelarts:image:delete | Write | - | g:EnterpriseProjectId | - | - | #### URI DELETE /v1/{project_id}/images/{id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释**：镜像ID，ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | project_id | 是 | String | **参数解释** ：用户项目ID，获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | force | 否 | Boolean | **参数解释**：删除在SWR的镜像内容，仅对于个人私有镜像有效。 **约束限制**：不涉及。 **取值范围**：布尔类型： - true：删除镜像内容。 - false：不删除镜像内容。 **默认取值**：false。 | #### 请求参数 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | is_force | 否 | Boolean | **参数解释**：删除在SWR的镜像内容，仅对于个人私有镜像有效。 **取值范围**：true/false。 | #### 响应参数 **状态码：200** 表4响应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。未使用SWR企业仓时该字段为null。 约束限制：不涉及。 取值范围：128位UUID。 默认取值：null。 | | show_name | String | **参数解释**：镜像展示名称，仅预置镜像具备该字段。 | | show_tag | String | **参数解释**：镜像展示版本号，仅预置镜像具备该字段。 | | tags | Array of [TmsTagResponse] objects | **参数解释**：镜像标签。 | 表5TmsTagResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**：TMS标签的key。 **取值范围**：不涉及。 | | value | String | **参数解释**：TMS标签的value。 **取值范围**：不涉及。 | **状态码：204** No Content。 #### 请求示例 ``` DELETE https://{endpoint}/v1/{project_id}/images/{id} ``` #### 响应示例 **状态码：200** ``` { "arch" : "x86_64", "create_at" : 1671093486722, "description" : "", "dev_services" : [ "NOTEBOOK", "SSH" ], "id" : "c9ab2b2f-edda-4556-bdbb-494e868d043c", "name" : "mock-service-python", "namespace" : "mock-service1", "origin" : "CUSTOMIZE", "resource_categories" : [ "CPU" ], "service_type" : "UNKNOWN", "size" : 387840321, "status" : "DELETED", "swr_path" : "swr.xxx.com/mock-service1/mock-service-python:0.0.17", "tag" : "0.0.17", "type" : "DEDICATED", "update_at" : 1671093486722, "visibility" : "PRIVATE", "workspace_id" : "0" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK。 | | 204 | No Content。 | | 401 | Unauthorized。 | | 403 | Forbidden。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。