
# 删除镜像组 - DeleteImageGroup
#### 功能介绍
删除镜像组接口用于删除镜像组内所有的版本对象，对于个人私有镜像可以通过参数一并删除SWR镜像内容。该接口适用于以下场景：当镜像不再需要、配置错误或需要清理资源时，用户可通过此接口删除指定的镜像组对象内所有版本。使用该接口的前提条件是镜像组已存在且用户具有删除权限。删除操作完成后，镜像组内所有版本对象将被永久移除，相关资源和配置也将被清理。若镜像组不存在、用户无权限操作或镜像正在被使用，接口将返回相应的错误信息。
#### 接口约束
暂无约束。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=DeleteImageGroup)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
DELETE /v1/{project_id}/images/group/{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)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 |
   
#### 请求参数
表2请求Body参数 
| 参数       | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| is_force | 否    | Boolean | 是否删除关联的swr镜像，默认为false **参数解释**：是否删除关联的swr镜像。 **约束限制**：true或false。 **取值范围**：布尔类型。 **默认取值**：false。 |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数                | 参数类型    | 描述                                                                                                                                          |
|:---|:---|:---|
| name              | String  | **参数解释**：镜像名称。 **取值范围**：不涉及。                                   |
| create_at         | Long    | **参数解释**：镜像创建的时间，单位：UTC毫秒。 **取值范围**：不涉及。                       |
| namespace         | String  | **参数解释**：镜像所属的SWR组织。 **取值范围**：不涉及。                             |
| update_at         | Long    | **参数解释**：镜像最后更新的时间，单位：UTC毫秒。 **取值范围**：不涉及。                     |
| version_count     | Integer | **参数解释**：镜像版本个数。 **取值范围**：不涉及。                                 |
| description       | String  | **参数解释**：镜像描述信息。 **取值范围**：不涉及。                                 |
| read_me           | String  | **参数解释**：镜像指导信息。 **取值范围**：不涉及。                                 |
| icon_name         | String  | **参数解释**：镜像图标名称。 **取值范围**：不涉及。                                 |
| id                | String  | **参数解释**：镜像id。 **取值范围**：不涉及。                                   |
| swr_instance_id   | String  | **参数解释**：SWR企业仓库ID。未使用SWR企业仓时该字段为null。 **取值范围**：0-128的0-9和a-z。 |
| swr_instance_name | String  | **参数解释**：SWR企业版镜像仓库名称。 **取值范围**：3-48个字符。                       |
   
**状态码：204**
No Content。
**状态码：401**
表4响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                |
|:---|:---|:---|
| error_code | String | **参数解释**：ModelArts错误码。 **取值范围**：不涉及。 |
| error_msg  | String | **参数解释**：具体错误信息。 **取值范围**：不涉及。       |
   
**状态码：403**
表5响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                |
|:---|:---|:---|
| error_code | String | **参数解释**：ModelArts错误码。 **取值范围**：不涉及。 |
| error_msg  | String | **参数解释**：具体错误信息。 **取值范围**：不涉及。       |
   
#### 请求示例
删除镜像组及关联的swr镜像内容
```
DELETE https://{endpoint}/v1/{project_id}/images/group/{id}
{
  "is_force" : true
}
```
#### 响应示例
**状态码：200**
OK。
```
{
  "create_at" : 1773668206040,
  "description" : "custome_image",
  "icon_name" : "Docker",
  "id" : "0679184a-c22a-4326-b94d-011224ada4a4",
  "name" : "pytorch",
  "namespace" : "image_dev",
  "read_me" : "### Redme \n\n",
  "update_at" : 1773668206040,
  "version_count" : 1
}
```
#### 状态码
| 状态码 | 描述            |
|:---|:---|
| 200 | OK。           |
| 204 | No Content。   |
| 401 | Unauthorized。 |
| 403 | Forbidden。    |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。
