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

获取网站资产

功能介绍

获取租户的所有网站资产

调试

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

URI

GET /v3/{project_id}/webscan/domains

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：32

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

domain_id

否

String

网站域名ID

最小长度：32

最大长度：32

auth_status

否

String

网站域名的认证状态:

  • unauth - 未认证

  • auth - 已认证

  • invalid - 认证文件无效

  • manual - 人工认证

  • skip - 免认证

枚举值：

  • unauth

  • auth

  • invalid

  • manual

  • skip

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

最大值：1000

top_level_domain_num

Integer

网站一级域名总数

最小值：0

最大值：1000

domains

Array of DomainItem objects

网站域名列表

数组长度：0 - 1000
表5 DomainItem

参数

参数类型

描述

high

Integer

高危漏洞数

最小值：0

最大值：1000

middle

Integer

中危漏洞数

最小值：0

最大值：1000

low

Integer

低危漏洞数

最小值：0

最大值：1000

hint

Integer

提示危漏洞数

最小值：0

最大值：1000

domain_id

String

网站域名ID

最小长度：32

最大长度：32

top_level_domain_id

String

一级域名ID

最小长度：32

最大长度：32

domain_name

String

网站域名

最小长度：1

最大长度：256

alias

String

网站域名的别名

最小长度：1

最大长度：50

create_time

String

创建网站域名资产的时间

最小长度：0

最大长度：19

auth_status

String

网站域名的认证状态:

  • unauth - 未认证

  • auth - 已认证

  • invalid - 认证文件无效

  • manual - 人工认证

  • skip - 免认证

枚举值：

  • unauth

  • auth

  • invalid

  • manual

  • skip

protocol_type

String

协议类型:

  • http:// - HTTP

  • https:// - HTTPS

枚举值：

  • http://

  • https://

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：50

error_msg

String

错误描述

最小长度：0

最大长度：256

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：50

error_msg

String

错误描述

最小长度：0

最大长度：256

状态码： 418

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：50

error_msg

String

错误描述

最小长度：0

最大长度：256

请求示例

GET https://{endpoint}/v3/{project_id}/webscan/domains

响应示例

状态码： 200

OK

{
  "total" : 1,
  "top_level_domain_num" : 1,
  "domains" : [ {
    "domain_id" : "2ec0993b8572455aacf14b6f9288b167",
    "top_level_domain_id" : "e38db200a348414f9c8df6418dab0765",
    "domain_name" : "127.0.0.1:8080",
    "alias" : "网站资产1",
    "create_time" : "2021-09-18 16:26:24",
    "auth_status" : "auth",
    "protocol_type" : "https://",
    "high" : 0,
    "middle" : 1,
    "low" : 0,
    "hint" : 2
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

418

I'm a teapot

错误码

请参见错误码。

父主题： 网站管理

相关文档