# 批量删除Pod - BatchDeleteInferDeploymentPod #### 功能介绍 本接口用于批量删除同个实例下指定的多个Pod，适用于需要清理或释放不再使用的Pod资源的场景。调用此接口前，确保已具备相应的删除权限，并提供有效的Pod ID列表。删除成功后，指定的Pod将被彻底移除，不再对任何服务请求生效。如果提供的Pod ID无效、Pod已删除或权限不足，将返回相应的异常信息，提示用户检查输入数据的有效性和权限。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=BatchDeleteInferDeploymentPod)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v2/{project_id}/services/{id}/deployments/{deployment_name}/instances/{instance_name}/pods/batch-delete 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制：** 不涉及。 **取值范围：** 账号的项目ID。 **默认取值：** 不涉及。 | | id | 是 | String | **参数解释：** 服务ID，在[创建服务](https://support.huaweicloud.com/api-modelarts/CreateInferService.html)时即可在返回体中获取，也可通过[查询服务列表](https://support.huaweicloud.com/api-modelarts/ListInferServices.html)获取当前用户拥有的服务，其中service_id字段即为服务ID。 **约束限制：** 不涉及。 **取值范围：** 服务ID。 **默认取值：** 不涉及。 | | deployment_name | 是 | String | **参数解释：** 部署名称，在创建部署时即可在返回体中获取，也可通过查询服务部署列表获取当前用户拥有的部署，其name字段即为部署名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_name | 是 | String | **参数解释：** 服务实例名字，可以为all，为all时去查询所有的服务实例。 **约束限制：** 不涉及。 **取值范围：** 服务实例名字。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。获取方法请参见[获取IAM用户Token（使用密码）](https://support.huaweicloud.com/api-modelarts/modelarts_03_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | pod_ids | 是 | Array of strings | **参数解释：** 批量删除的pod ID列表。 **约束限制：** 0 \< id个数 \<= 50。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释：** 删除的Pod总数。 **取值范围：** \[1, 50\]。 | | success_count | Integer | **参数解释：** 删除成功的Pod数。 **取值范围：** \[0, 50\]。 | | failure_count | Integer | **参数解释：** 删除失败的Pod数。 **取值范围：** \[0, 50\]。 | | success_items | Array of [BatchDeletePodSuccessItem] objects | **参数解释：** 删除成功的pod ID列表。 **取值范围：** 不涉及。 | | failure_items | Array of [BatchDeletePodFailureItem] objects | **参数解释：** 删除失败的pod ID列表。 **取值范围：** 不涉及。 | 表5BatchDeletePodSuccessItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pod_id | String | **参数解释：** 删除成功的pod ID。 **取值范围：** 不涉及。 | 表6BatchDeletePodFailureItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pod_id | String | **参数解释：** 删除失败的pod ID。 **取值范围：** 不涉及。 | | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误信息。 **取值范围：** 不涉及。 | **状态码：207** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释：** 删除的Pod总数。 **取值范围：** \[1, 50\]。 | | success_count | Integer | **参数解释：** 删除成功的Pod数。 **取值范围：** \[0, 50\]。 | | failure_count | Integer | **参数解释：** 删除失败的Pod数。 **取值范围：** \[0, 50\]。 | | success_items | Array of [BatchDeletePodSuccessItem] objects | **参数解释：** 删除成功的pod ID列表。 **取值范围：** 不涉及。 | | failure_items | Array of [BatchDeletePodFailureItem] objects | **参数解释：** 删除失败的pod ID列表。 **取值范围：** 不涉及。 | 表8BatchDeletePodSuccessItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pod_id | String | **参数解释：** 删除成功的pod ID。 **取值范围：** 不涉及。 | 表9BatchDeletePodFailureItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pod_id | String | **参数解释：** 删除失败的pod ID。 **取值范围：** 不涉及。 | | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误信息。 **取值范围：** 不涉及。 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：ModelArts错误码。 **取值范围**：不涉及。 | | error_msg | String | **参数解释**：具体错误信息。 **取值范围**：不涉及。 | **状态码：401** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：ModelArts错误码。 **取值范围**：不涉及。 | | error_msg | String | **参数解释**：具体错误信息。 **取值范围**：不涉及。 | **状态码：403** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：ModelArts错误码。 **取值范围**：不涉及。 | | error_msg | String | **参数解释**：具体错误信息。 **取值范围**：不涉及。 | **状态码：404** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：ModelArts错误码。 **取值范围**：不涉及。 | | error_msg | String | **参数解释**：具体错误信息。 **取值范围**：不涉及。 | #### 请求示例 批量删除指定实例下的两个pod。 ``` POST https://{endpoint}/v2/{project_id}/services/{service_id}/deployments/{deployment_id}/instances/{name}/pods/batch-delete { "pod_ids" : [ "dc07b311-68c6-42a3-93e4-e2277a22f9b3", "b20cb724-7ac0-4e99-b32f-6a43f0e59887" ] } ``` #### 响应示例 **状态码：200** ``` { "failure_count" : 0, "failure_items" : [ ], "success_count" : 2, "success_items" : [ { "pod_id" : "dc07b311-68c6-42a3-93e4-e2277a22f9b3" }, { "pod_id" : "b20cb724-7ac0-4e99-b32f-6a43f0e59887" } ], "total" : 2 } ``` **状态码：207** ``` { "failure_count" : 2, "failure_items" : [ { "error_code" : "ModelArts.8240", "error_msg" : "删除pod失败，原因：pod已被删除", "pod_id" : "354566e3-4e50-4d14-8682-3c0354788c17" }, { "error_code" : "ModelArts.8240", "error_msg" : "删除pod失败，原因：pod不存在", "pod_id" : "100bfe1a-59f9-4d52-b6ac-de5ee00ac2201" } ], "success_count" : 1, "success_items" : [ { "pod_id" : "dc07b311-68c6-42a3-93e4-e2277a22f9b3" } ], "total" : 3 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 删除成功响应。 | | 207 | 删除部分失败响应 | | 400 | 请求参数不合法。 | | 401 | 鉴权非法。 | | 403 | 权限不足。 | | 404 | 资源未找到。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。