
# 批量取消作业 - BatchCancelJob
#### 功能介绍
批量取消作业。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0100.html)。
#### URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/batch-terminate
表1路径参数 
| 参数                  | 是否必选 | 参数类型   | 描述                                                                                                                                                                                |
|:---|:---|:---|:---|
| project_id          | 是    | String | **参数解释**： 项目ID，您可以从[获取项目ID](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0033.html)中获取。 **约束限制**： 不涉及 **取值范围**： 仅支持字母、数字、中划线和下划线，长度为\[1-128\]个字符。 **默认取值**： 不涉及 |
| eihealth_project_id | 是    | String | **参数解释**： 空间ID，您可以从[获取空间ID](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0099.html)中获取。 **约束限制**： 不涉及 **取值范围**： 仅支持字母、数字、中划线和下划线，长度为\[1-128\]个字符。 **默认取值**： 不涉及 |
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String  | **参数解释**： 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，[获取Token](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0011.html)接口响应消息头中X-Subject-Token的值即为Token。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-32768\]个字符。 **默认取值**： 不涉及 |
| X-Force      | 否    | Boolean | **参数解释**： 是否强制停止作业。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                                                                                                                                                                                        |
   
表3请求Body参数 
| 参数  | 是否必选 | 参数类型             | 描述                                                                                                           |
|:---|:---|:---|:---|
| ids | 是    | Array of strings | **参数解释**： 批量操作的作业ID列表。 **约束限制**： 仅支持字母、数字、下划线和中划线，长度为\[1-128\]个字符。最多支持设置50个作业ID。 **取值范围**： 不涉及 **默认取值**： 不涉及 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数       | 参数类型                                                                                | 描述      |
|:---|:---|:---|
| \[数组元素\] | Array of [BatchOperateJobRsp] objects | 批量操作响应体 |
   
 表5BatchOperateJobRsp 
| 参数      | 参数类型   | 描述                                                                                    |
|:---|:---|:---|
| id      | String | **参数解释**： 作业ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                             |
| status  | String | **参数解释**： 批量操作作业的结果。 **约束限制**： 不涉及 **取值范围**： - SUCCEEDED：成功 - FAILED：失败 **默认取值**： 不涉及 |
| message | String | 操作结果失败信息，仅在操作失败时会返回。                                                                  |
   
**状态码：207**
表6响应Body参数 
| 参数       | 参数类型                                                                                  | 描述      |
|:---|:---|:---|
| \[数组元素\] | Array of [BatchOperateJobRsp] objects | 批量操作响应体 |
   
 表7BatchOperateJobRsp 
| 参数      | 参数类型   | 描述                                                                                    |
|:---|:---|:---|
| id      | String | **参数解释**： 作业ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                             |
| status  | String | **参数解释**： 批量操作作业的结果。 **约束限制**： 不涉及 **取值范围**： - SUCCEEDED：成功 - FAILED：失败 **默认取值**： 不涉及 |
| message | String | 操作结果失败信息，仅在操作失败时会返回。                                                                  |
   
#### 请求示例
批量取消作业，取消如下两个作业，默认强制终止模式。
```
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/batch-terminate
{
  "ids" : [ "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "baabcb56-5bb6-11eb-8a0d-fa163e3ddba2" ]
}
```
#### 响应示例
**状态码：200**
OK
```
[ {
  "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
  "status" : "SUCCEEDED",
  "message" : "string"
} ]
```
**状态码：207**
MULTI_STATUS
```
[ {
  "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
  "status" : "SUCCEEDED",
  "message" : "string"
}, {
  "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba2",
  "status" : "FAILED",
  "message" : "string"
} ]
```
#### 状态码
| 状态码 | 描述           |
|:---|:---|
| 200 | OK           |
| 207 | MULTI_STATUS |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ai4sservice/ErrorCode.html)。
