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

获取网站扫描报告状态

功能介绍

获取网站扫描PDF报告生成状态

调试

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

URI

GET /v3/{project_id}/webscan/report/status

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

String

任务ID

最小长度：32

最大长度：50

report_status

String

PDF报告生成状态:

  • ungenerated - 未生成

  • generating - 生成中

  • generated - 已生成

  • failed - 生成失败

枚举值：

  • ungenerated

  • generating

  • generated

  • failed

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

请求示例

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

响应示例

状态码： 200

OK

{
  "task_id" : "017281b97c9845b08174895992ba179643028",
  "report_status" : "generated"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

418

I'm a teapot

错误码

请参见错误码。

父主题： 网站报告管理

相关文档