更新时间:2024-10-14 GMT+08:00
分享

获取网站扫描任务详情

功能介绍

获取网站漏洞扫描任务详情

调试

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

URI

GET /v3/{project_id}/webscan/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:32

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

task_id

String

任务ID

最小长度:32

最大长度:50

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:102400

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

task_name

String

任务名称

最小长度:1

最大长度:16

url

String

待扫描的目标网址

最小长度:1

最大长度:256

task_type

String

扫描任务类型:

  • normal - 普通任务

  • monitor - 监测任务

缺省值:normal

枚举值:

  • normal

  • monitor

task_id

String

任务ID

最小长度:32

最大长度:50

domain_name

String

网站域名

最小长度:1

最大长度:256

task_settings

TaskSettings object

扫描任务设置

create_time

String

创建任务的时间

最小长度:0

最大长度:19

start_time

String

任务启动的时间

最小长度:0

最大长度:19

end_time

String

任务结束的时间

最小长度:0

最大长度:19

task_status

String

任务状态:

  • running - 正在运行

  • success - 成功

  • canceled - 已取消

  • waiting - 正在等待

  • ready - 已就绪,排队中

  • failure - 失败

枚举值:

  • running

  • success

  • canceled

  • waiting

  • ready

  • failure

schedule_status

String

监测任务状态:

  • running - 正在运行

  • waiting - 正在等待

  • finished - 已完成

枚举值:

  • running

  • waiting

  • finished

progress

Integer

任务进度

最小值:0

最大值:100

reason

String

任务状态描述

最小长度:0

最大长度:128

pack_num

Long

包总数

最小值:0

最大值:100000

score

Integer

安全分数

最小值:0

最大值:100

safe_level

String

安全等级:

  • safety - 安全

  • average - 中风险

  • highrisk - 高风险

枚举值:

  • safety

  • average

  • highrisk

statistics

VulnsLevel object

漏洞风险等级统计

表5 TaskSettings

参数

参数类型

描述

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

扫描任务配置

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

表7 VulnsLevel

参数

参数类型

描述

high

Integer

高危漏洞数

最小值:0

最大值:1000

middle

Integer

中危漏洞数

最小值:0

最大值:1000

low

Integer

低危漏洞数

最小值:0

最大值:1000

hint

Integer

提示危漏洞数

最小值:0

最大值:1000

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:50

error_msg

String

错误描述

最小长度:0

最大长度:256

状态码: 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:50

error_msg

String

错误描述

最小长度:0

最大长度:256

状态码: 418

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:50

error_msg

String

错误描述

最小长度:0

最大长度:256

请求示例

GET https://{endpoint}/v3/{project_id}/webscan/tasks?task_id=017281b97c9845b08174895992ba179643028

响应示例

状态码: 200

OK

{
  "task_id" : "017281b97c9845b08174895992ba179643028",
  "task_name" : "测试任务1",
  "url" : "https://127.0.0.1:8080",
  "task_type" : "normal",
  "domain_name" : "127.0.0.1:8080",
  "task_settings" : {
    "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
    }
  },
  "create_time" : "2021-09-18 16:26:24",
  "start_time" : "2021-09-18 16:26:24",
  "end_time" : "2021-09-18 17:00:00",
  "task_status" : "success",
  "progress" : 100,
  "reason" : "Successful. Your website is very safe!",
  "pack_num" : 5,
  "score" : 100,
  "safe_level" : "safety",
  "statistics" : {
    "high" : 0,
    "middle" : 0,
    "low" : 0,
    "hint" : 0
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

418

I'm a teapot

错误码

请参见错误码

相关文档