
# 结束任务 - StopJobAction
#### 功能介绍
结束租户指定ID任务。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DRS/doc?api=StopJobAction&version=v5)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-drs/drs_api_0035.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
POST /v5/{project_id}/jobs/{job_id}/stop
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                  |
|:---|:---|:---|:---|
| project_id | 是    | String | 租户在某一Region下的Project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-drs/drs_api_0106.html)。 |
| job_id     | 是    | String | 任务ID。                                                                                                                                               |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| Content-Type | 是    | String | 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：**application/json**                                                                                                                                                                                                                      |
| X-Auth-Token | 是    | String | 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。                                                                                                                                                              |
| X-Language   | 否    | String | 请求语言类型。 枚举值： - **en-us**  - **zh-cn**   |
   
表3请求Body参数 
| 参数            | 是否必选 | 参数类型    | 描述                                                                                |
|:---|:---|:---|:---|
| is_force_stop | 否    | Boolean | 强制结束任务时取值true，默认false。 缺省值：**false** |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|
| error_code | String | 错误码。 最小长度：**12** 最大长度：**12**                                                                                                                                                                                                                                                                      |
| error_msg  | String | 错误描述。 最小长度：**1** 最大长度：**512**                                                                                                                                                                                                                                                                    |
| id         | String | 任务ID。                                                                                                                                                                                                                                                                                                                                                                                         |
| name       | String | 任务名称。                                                                                                                                                                                                                                                                                                                                                                                         |
| status     | String | 操作结果。 取值范围： - **success**：成功  - **failed**：失败   |
   
**状态码：400**
表5响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                       |
|:---|:---|:---|
| error_code | String | 错误码。 最小长度：**12** 最大长度：**12**  |
| error_msg  | String | 错误描述。 最小长度：**1** 最大长度：**512** |
   
#### 请求示例
结束任务（异步调用）：
```
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/stop
{
  "is_force_stop" : true
}
```
#### 响应示例
**状态码：200**
```
{
  "id": "dab6c37c-b277-4f79-96aa-a671e7fjb201",
  "name": "DRS-8427",
  "status" : "success"
}
```
**状态码：400**
Bad Request
```
{
  "error_code" : "DRS.10000010",
  "error_msg" : "Job does not exist, please check job id."
}
```
#### 状态码
| 状态码 | 描述          |
|:---|:---|
| 200 | OK          |
| 400 | Bad Request |
   
其他状态请参见[状态码](https://support.huaweicloud.com/api-drs/drs_api_0108.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-drs/drs_05_0004.html)。
