取消或重启网站扫描任务

功能介绍

取消或重启网站漏洞扫描任务

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v3/{project_id}/webscan/tasks

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	用户的project_id，获取方法请参见获取项目ID。最小长度：32 最大长度：32

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。最小长度：1 最大长度：102400

表3 请求Body参数
参数	是否必选	参数类型	描述
task_id	是	String	任务ID 最小长度：32 最大长度：50
action	是	String	对扫描任务的操作: cancel - 取消扫描任务 restart - 重启扫描任务枚举值： cancel restart

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
info_code	String	状态码: success - 成功 failure - 失败枚举值： success failure
info_description	String	返回的提示信息最小长度：0 最大长度：64
task_id	String	任务ID 最小长度：32 最大长度：50
task_status	String	任务状态: running - 正在运行 success - 成功 canceled - 已取消 waiting - 正在等待 ready - 已就绪，排队中 failure - 失败枚举值： running success canceled waiting ready failure

状态码： 400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码最小长度：0 最大长度：50
error_msg	String	错误描述最小长度：0 最大长度：256

状态码： 401

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码最小长度：0 最大长度：50
error_msg	String	错误描述最小长度：0 最大长度：256

状态码： 418

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码最小长度：0 最大长度：50
error_msg	String	错误描述最小长度：0 最大长度：256

请求示例

PUT https://{endpoint}/v3/{project_id}/webscan/tasks

{
  "task_id" : "017281b97c9845b08174895992ba179643028",
  "action" : "cancel"
}

响应示例

状态码： 200

{
  "info_code" : "success",
  "info_description" : "Operation succeeded",
  "task_id" : "017281b97c9845b08174895992ba179643028",
  "task_status" : "canceled"
}