停止、暂停或恢复任务 - stopTaskByIdUsingPUT
功能介绍
根据请求参数，停止、暂停、或恢复功能自动化任务
调用方法
请参见如何调用API。
URI
PUT /attask/v1/task/{taskId}/stopTask
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| taskId | 是 | String | 参数解释 任务ID 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 获取方式 从 POST /v3/task/list 的返回结果中对应的id字段获取。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 否 | Integer | 参数解释 任务分类，常规任务不传，拨测请传1 约束限制 不涉及 取值范围 字符串长度不少于1 默认取值 不涉及 |
| stopType | 否 | String | 参数解释 任务停止类型，1:等待执行器停止，2:立即停止 约束限制 不涉及 取值范围 字符串长度不少于1 默认取值 不涉及 |
| testServiceId | 否 | String | 参数解释 服务ID 约束限制 只能传对应的任务类型值 取值范围 不涉及 默认取值 不涉及 获取方式 从 GET /rest/me 的返回结果中 projectId 字段获取。 |
| actionType | 否 | String | 参数解释 任务类型,stop:停止任务组,pause:暂停任务组,resume:恢复任务组,stopChildTask:停止子任务,pauseChildTask:暂停子任务,resumeChildTask:恢复子任务 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 请求状态：OK - 成功 |
| result | Object | 返回结果 |
| request_id | String | 请求id |
| server_ip | String | 服务节点IP |
状态码：201
Created
状态码：401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 请求状态："failed" - 失败 |
| request_id | String | 请求id |
| server_ip | String | 服务节点IP |
| error_msg | String | 错误信息 |
| error_code | String | 错误码 |
| error_cause | String | 错误原因 |
| faq | String | faq内容 |
状态码：403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 请求状态："failed" - 失败 |
| request_id | String | 请求id |
| server_ip | String | 服务节点IP |
| error_msg | String | 错误信息 |
| error_code | String | 错误码 |
| error_cause | String | 错误原因 |
| faq | String | faq内容 |
状态码：404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 请求状态："failed" - 失败 |
| request_id | String | 请求id |
| server_ip | String | 服务节点IP |
| error_msg | String | 错误信息 |
| error_code | String | 错误码 |
| error_cause | String | 错误原因 |
| faq | String | faq内容 |
请求示例
停止任务
put https://{endpoint}/attask/v1/task/{taskId}/stopTask
{ } 响应示例
状态码：200
OK
{
"result" : "暂停成功",
"requestId" : "",
"serverIp" : "",
"status" : "OK"
} 状态码：401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "认证信息过期"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
错误码
请参见错误码。
