
# 批量停止作业 - BatchStopFlinkJobs
#### 功能介绍
该API用于批量停止正在运行的作业。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DLI/doc?api=StopFlinkJobs)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限及授权项说明](https://support.huaweicloud.com/api-dli/dli_02_0375.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项 Action | 访问级别 Access Level | 资源类型（\*为必须） Resource Type (\*: required) | 条件键 Condition Key                                                                                                                                                  | 别名 Alias | 依赖的授权项 Dependencies |
  |:---|:---|:---|:---|:---|:---|
  | dli:jobs:stopFlinkJob                   | write                                           | jobs \*                                                                | - [g:ResourceTag/\<tag-key\>](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html)   | -                                      | -                                                 |
     
  
 
#### URI
- URI格式 POST /v1.0/{project_id}/streaming/jobs/stop
  
- 参数说明
  表1URI参数说明 
  | 参数名称       | 是否必选 | 参数类型   | 说明                                                                                     |
  |:---|:---|:---|:---|
  | project_id | 是    | String | 项目编号，用于资源隔离。获取方式请参考[获取项目ID](https://support.huaweicloud.com/api-dli/dli_02_0183.html)。 |
     
  
 
#### 请求消息
表2请求参数说明 
| 参数名称              | 是否必选 | 参数类型          | 说明                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| job_ids           | 是    | Array of Long | 作业ID。                                                                                                                                                                                                                                                                                                                |
| trigger_savepoint | 否    | Boolean       | 在停止作业之前，用户可以选择是否对作业创建保存点，保存作业的状态信息。类型为boolean。 - 当triggerSavePoint为true时，表示创建保存点。  - 当triggerSavePoint为false时，表示不创建保存点。默认为false。   |
   
#### 响应消息
表3响应参数说明 
| 参数名称 | 是否必选 | 参数类型             | 说明                                                                   |
|:---|:---|:---|:---|
| 数组元素 | 否    | Array of Objects | 返回的响应消息组。具体请参考[表4]。 |
   
 表4数组元素参数说明 
| 参数名称       | 是否必选 | 参数类型   | 说明                       |
|:---|:---|:---|:---|
| is_success | 否    | String | 执行请求是否成功。"true"表示请求执行成功。 |
| message    | 否    | String | 消息内容。                    |
   
#### 请求示例
停止运行ID为128和137的作业。
```
{
  "job_ids": [128, 137],
  "trigger_savepoint": false
}
```
#### 响应示例
```
[{"is_success":"true",
"message":"作业停止请求下发成功"}]
```
#### 状态码
状态码如[表5]所示。
 表5状态码 
| 状态码 | 描述           |
|:---|:---|
| 200 | 停止作业的请求发送成功。 |
| 400 | 输入参数无效。      |
   
#### 错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见[错误码](https://support.huaweicloud.com/api-dli/dli_02_0056.html)。
