更新时间:2025-08-30 GMT+08:00
分享

查询漏洞列表

功能介绍

查询漏洞列表

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/vulnerability/search

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

limit

Integer

分页大小

offset

Integer

偏移量

sort_by

String

排序字段:create_time | update_time

order

String

排序方式:DESC | ASC

from_date

String

搜索开始时间,例如:2023-02-20T00:00:00.000Z

to_date

String

搜索结束时间,例如:2023-02-27T23:59:59.999Z

condition

condition object

搜索条件表达式

表3 condition

参数

是否必选

参数类型

描述

conditions

Array of conditions objects

表达式列表

logics

Array of strings

表达式名称列表

表4 conditions

参数

是否必选

参数类型

描述

name

String

表达式名称

data

Array of strings

表达式内容列表

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误信息

total

Integer

漏洞总数

size

Integer

分页大小

page

Integer

偏移量

success

Boolean

是否成功

data

Array of VulnerabilityDetail objects

漏洞列表

表6 VulnerabilityDetail

参数

参数类型

描述

id

String

漏洞id

format_version

Integer

格式版本

version

Integer

版本

project_id

String

当前项目的id

workspace_id

String

当前的工作空间id

create_time

String

创建时间,格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区,无法解析时区的时间,默认时区填东八区

update_time

String

更新时间,格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区,无法解析时区的时间,默认时区填东八区

dataclass_ref

dataclass_ref object

数据类对象

data_object

VulnerabilityDataObject object

数据类

表7 dataclass_ref

参数

参数类型

描述

id

String

数据类唯一标识,UUID格式,最大36个字符

name

String

数据类名称

表8 VulnerabilityDataObject

参数

参数类型

描述

vul_name

String

漏洞名称

first_observed_time

String

首次发现时间

batch_number

String

漏洞批次号

description

String

漏洞描述

resource_num

Integer

受影响的资产数量

domain_id

String

租户id

workspace_id

String

工作空间id

remediation

remediation object

修复建议

domain_name

String

租户名称

update_time

String

更新时间

is_deleted

Boolean

是否删除

project_id

String

项目ID

extend_properties

extend_properties object

扩展属性

region_name

String

区域名称

id

String

漏洞公告ID

vulnerability_type

vulnerability_type object

漏洞类型信息

create_time

String

创建时间

last_observed_time

String

最后发现时间

resource

resource object

资产信息

count

Integer

漏洞计数

region_id

String

区域ID

vulnerability

vulnerability object

漏洞详细信息

dataclass_id

String

数据分类ID

version

String

漏洞版本号

data_source

data_source object

数据来源

arrive_time

String

数据到达时间

environment

environment object

环境信息

trigger_flag

Boolean

是否触发标记

handled

Integer

处理状态

表9 remediation

参数

参数类型

描述

recommendation

String

推荐修复措施

表10 extend_properties

参数

参数类型

描述

operations

operations object

扩展操作属性

表11 operations

参数

参数类型

描述

is_build_in

String

是否内置属性,取值说明:false 表示手工导入漏洞;true 表示内置漏洞

表12 vulnerability_type

参数

参数类型

描述

id

String

类型ID

category

String

漏洞类别

category_en

String

漏洞类别英文

category_zh

String

漏洞类别中文

vulnerability_type

String

漏洞类型

vulnerability_type_en

String

漏洞类型英文

vulnerability_type_zh

String

漏洞类型中文

表13 resource

参数

参数类型

描述

id

String

资产ID

name

String

资产名称

type

String

资产类型

provider

String

提供商

region_id

String

区域ID

domain_id

String

租户ID

project_id

String

项目ID

ep_id

String

企业项目ID

tags

Map<String,String>

资产标签

表14 vulnerability

参数

参数类型

描述

id

String

漏洞ID

type

Integer

漏洞类型编号

url

String

漏洞链接

status

Integer

漏洞状态

level

String

漏洞等级

reason

String

漏洞产生原因

solution

String

漏洞解决方案

repair_severity

Integer

修复紧急程度

related

Array of strings

相关漏洞

tags

Array of strings

漏洞标签

表15 data_source

参数

参数类型

描述

domain_id

String

租户ID

project_id

String

项目ID

region_id

String

区域ID

company_name

String

公司名称

source_type

Integer

来源类型

product_name

String

产品名称

product_feature

String

产品特性

表16 environment

参数

参数类型

描述

domain_id

String

租户ID

domain_name

String

租户名称

project_id

String

项目ID

region_id

String

区域ID

region_name

String

区域名称

vendor_type

String

厂商类型

请求示例

响应示例

状态码

状态码

描述

200

搜索漏洞列表返回body体

错误码

请参见错误码

相关文档