文档首页/ 漏洞管理服务 CodeArts Inspector/ API参考/ API/ 网站报告管理/ 获取网站扫描结果
更新时间：2024-10-14 GMT+08:00
查看PDF
分享

获取网站扫描结果

功能介绍

获取网站漏洞扫描结果

调试

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

URI

GET /v3/{project_id}/webscan/results

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：32

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

task_id

是

String

任务ID

最小长度：32

最大长度：50

offset

否

Integer

分页查询，偏移量，表示从此偏移量开始查询

最小值：0

最大值：10000

缺省值：0

limit

否

Integer

分页查询，每页显示的条目数量

最小值：1

最大值：10000

缺省值：5

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：102400

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

网站漏洞总数

最小值：0

最大值：100000

data

Array of VulnItem objects

网站漏洞信息列表

数组长度：0 - 100000

statistics

VulnsLevel object

网站漏洞风险等级统计
表5 VulnItem

参数

参数类型

描述

vuln_id

String

漏洞ID

最小长度：32

最大长度：32

domain_id

String

网站域名ID

最小长度：32

最大长度：32

url

String

目标网址

最小长度：1

最大长度：256

severity

String

漏洞风险等级:

  • high - 高风险

  • middle - 中风险

  • low - 低风险

  • hint - 提示

枚举值：

  • high

  • middle

  • low

  • hint

vuln_status

String

漏洞状态:

  • repairing - 未修复

  • repaired - 已修复

  • false_report - 误报，已忽略

枚举值：

  • repairing

  • repaired

  • false_report

vuln_class

String

漏洞类别

最小长度：0

最大长度：64

vuln_type

String

漏洞名称

最小长度：0

最大长度：64

description

String

漏洞描述

最小长度：0

最大长度：1000

advice

String

修复建议

最小长度：0

最大长度：1000

hit_details

String

命中详情

最小长度：0

最大长度：1000000

request

String

请求详情

最小长度：0

最大长度：1000000

response

String

响应详情

最小长度：0

最大长度：1000000

provider

String

漏洞确认人

最小长度：0

最大长度：32

reason

String

漏洞忽略理由

最小长度：0

最大长度：1000

find_time

String

漏洞发现时间

最小长度：0

最大长度：19
表6 VulnsLevel

参数

参数类型

描述

high

Integer

高危漏洞数

最小值：0

最大值：1000

middle

Integer

中危漏洞数

最小值：0

最大值：1000

low

Integer

低危漏洞数

最小值：0

最大值：1000

hint

Integer

提示危漏洞数

最小值：0

最大值：1000

状态码： 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

请求示例

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

响应示例

状态码： 200

OK

{
  "total" : 1,
  "data" : [ {
    "vuln_id" : "006e7c21dc390410c2270bf9bebf7b1e",
    "domain_id" : "2ec0993b8572455aacf14b6f9288b167",
    "url" : "https://127.0.0.1:8080/examples/test.html",
    "severity" : "middle",
    "vuln_status" : "repairing",
    "vuln_class" : "CSRF",
    "vuln_type" : "Cross-Site Request Forgery",
    "description" : "Attackers can induce web visitors to send requests to servers to cause request forgery, causing loss of web visitor data.",
    "advice" : "Use secure anti-csrf tokens to prevent CSRF and replay.",
    "hit_details" : "Referer",
    "request" : "The first request ------------------",
    "response" : "The first response ------------------",
    "find_time" : "2021-09-18 16:26:24"
  } ],
  "statistics" : {
    "high" : 0,
    "middle" : 1,
    "low" : 0,
    "hint" : 0
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

418

I'm a teapot

错误码

请参见错误码。

父主题： 网站报告管理

相关文档