文档首页/ 漏洞管理服务 CodeArts Inspector/ API参考/ API/ 网站任务管理/ 创建网站扫描任务并启动
更新时间：2024-10-14 GMT+08:00
查看PDF
分享

创建网站扫描任务并启动

功能介绍

创建网站漏洞扫描任务并启动

调试

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

URI

POST /v3/{project_id}/webscan/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户的project_id，获取方法请参见获取项目ID。

最小长度：32

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

upgrade

否

Boolean

是否将本次扫描升级为专业版规格（￥99.00/次）

缺省值：false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

最小长度：1

最大长度：102400
表4 请求Body参数

参数

是否必选

参数类型

描述

task_name

是

String

任务名称

最小长度：1

最大长度：16

url

是

String

待扫描的目标网址

最小长度：1

最大长度：256

task_type

否

String

扫描任务类型:

  • normal - 普通任务

  • monitor - 监测任务

缺省值：normal

枚举值：

  • normal

  • monitor

timer

否

String

普通任务的定时启动时间

最小长度：0

最大长度：19

trigger_time

否

String

监测任务的定时触发时间

最小长度：0

最大长度：19

task_period

否

String

监测任务的定时触发周期:

  • everyday - 每日

  • threedays - 每三天

  • everyweek - 每星期

  • everymonth - 每月

枚举值：

  • everyday

  • threedays

  • everyweek

  • everymonth

task_config

否

task_config object

扫描任务配置
表5 task_config

参数

是否必选

参数类型

描述

scan_mode

否

String

扫描模式:

  • fast - 快速扫描

  • normal - 标准扫描

  • deep - 深度扫描

缺省值：normal

枚举值：

  • fast

  • normal

  • deep

port_scan

否

Boolean

是否进行端口扫描

缺省值：true

weak_pwd_scan

否

Boolean

是否进行弱密码扫描

缺省值：true

cve_check

否

Boolean

是否进行CVE漏洞扫描

缺省值：true

text_check

否

Boolean

是否进行网站内容合规文字检测

缺省值：true

picture_check

否

Boolean

是否进行网站内容合规图片检测

缺省值：false

malicious_code

否

Boolean

是否进行网站挂马检测

缺省值：false

malicious_link

否

Boolean

是否进行链接健康检测（死链、暗链、恶意外链）

缺省值：false

响应参数

状态码： 200

表6 响应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

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：50

error_msg

String

错误描述

最小长度：0

最大长度：256

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：50

error_msg

String

错误描述

最小长度：0

最大长度：256

状态码： 418

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：50

error_msg

String

错误描述

最小长度：0

最大长度：256

请求示例

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

{
  "task_name" : "测试任务1",
  "url" : "https://127.0.0.1:8080",
  "task_type" : "normal",
  "task_config" : {
    "scan_mode" : "normal",
    "port_scan" : false,
    "weak_pwd_scan" : false,
    "cve_check" : false,
    "text_check" : false,
    "picture_check" : false,
    "malicious_code" : false,
    "malicious_link" : false
  }
}

响应示例

状态码： 200

OK

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

418

I'm a teapot

错误码

请参见错误码。

父主题： 网站任务管理

相关文档