查询威胁情报列表
功能介绍
查询威胁情报列表
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/indicators/search
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
workspace_id |
是 |
String |
工作空间ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
租户的Token |
|
content-type |
是 |
String |
application/json;charset=UTF-8 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
ids |
否 |
Array of strings |
威胁情报ID列表 |
|
dataclass_id |
否 |
String |
数据类ID |
|
condition |
是 |
condition object |
搜索条件表达式 |
|
offset |
是 |
Integer |
request offset, from 0 |
|
limit |
是 |
Integer |
request limit size |
|
sort_by |
否 |
String |
sort by property, create_time. |
|
from_date |
否 |
String |
查询起始时间,例如:2024-01-20T00:00:00.000Z+0800 |
|
to_date |
否 |
String |
查询截止时间,例如:2024-01-26T23:59:59.999Z+0800 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
conditions |
否 |
Array of conditions objects |
表达式列表 |
|
logics |
否 |
Array of strings |
表达式名称列表 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
错误信息 |
|
total |
Integer |
总数 |
|
data |
Array of IndicatorDetail objects |
指标列表数据 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
威胁情报ID |
|
name |
String |
威胁情报名称 |
|
data_object |
IndicatorDataObjectDetail object |
情报详情 |
|
workspace_id |
String |
工作空间ID |
|
project_id |
String |
项目ID |
|
dataclass_ref |
DataClassRefPojo object |
数据类对象信息 |
|
create_time |
String |
创建时间 |
|
update_time |
String |
更新时间 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
indicator_type |
indicator_type object |
情报类型对象 |
|
value |
String |
值,如:ip url domain等 |
|
update_time |
String |
更新时间 |
|
create_time |
String |
创建时间 |
|
environment |
environment object |
环境信息 |
|
data_source |
data_source object |
数据源信息 |
|
first_report_time |
String |
首次发生时间 |
|
is_deleted |
Boolean |
是否删除 |
|
last_report_time |
String |
最近发生时间 |
|
granular_marking |
Integer |
粒度(保密等级),由高到低:1(首次发现)、2(自产数据)、3(需购买)、4(外网直接查询) |
|
name |
String |
名称 |
|
id |
String |
威胁情报ID |
|
project_id |
String |
项目ID |
|
revoked |
Boolean |
是否作废 |
|
status |
String |
状态, Open--打开,Closed--关闭, Revoked--作废 |
|
verdict |
String |
威胁度, Black--黑,White--白,Gray--灰 |
|
workspace_id |
String |
工作空间ID |
|
confidence |
Integer |
置信度,取值范围是80-100 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vendor_type |
String |
环境供应商 |
|
domain_id |
String |
租户ID |
|
region_id |
String |
区域ID |
|
project_id |
String |
项目ID |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
source_type |
Integer |
数据源类型,取值范围如下:1 - 云上产品 2 - 第三方产品 3 - 租户私有产品 |
|
domain_id |
String |
租户ID |
|
project_id |
String |
项目ID |
|
region_id |
String |
区域ID |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
错误描述 |
请求示例
查询id为id1、id2,名称为威胁情报名称,类型为DATA_SOURCE,数据类id为28f61af50fc9452aa0ed5ea25c3cc3d3的威胁情报列表,偏移量为0,查询上限10条,根据create_time排序
{
"ids" : [ "id1", "id2" ],
"dataclass_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3",
"condition" : {
"conditions" : [ {
"name" : "name",
"data" : [ "name", "=", "威胁情报名称" ]
} ],
"logics" : [ "title" ]
},
"offset" : 0,
"limit" : 10,
"sort_by" : "create_time",
"from_date" : "2024-01-20T00:00:00.000Z+0800",
"to_date" : "2024-01-26T23:59:59.999Z+0800"
}
响应示例
状态码:200
请求成功响应信息
{
"code" : "00000000",
"data" : [ {
"create_time" : "2023-07-24T20:54:19Z+0800",
"data_object" : {
"indicator_type" : {
"indicator_type" : "ipv6",
"id" : "ac794b2dfab9fe8c0676587301a636d3"
},
"revoked" : false,
"workspace_id" : "d5baeef8-3e75-4e91-9826-fb208ac58987",
"update_time" : "2023-07-24T20:54:19.038Z+0800",
"project_id" : "15645222e8744afa985c93dab6341da6",
"first_report_time" : "2023-07-31T20:54:12.000Z+0800",
"id" : "ff61d1f8-0de4-4077-9e9b-e312f6829c6d",
"granular_marking" : 1,
"value" : "{}",
"create_time" : "2023-07-24T20:54:19.038Z+0800",
"confidence" : 80,
"last_report_time" : "2023-07-25T20:54:15.000Z+0800",
"data_source" : {
"domain_id" : "ac7438b990ef4a37b741004eb45e8bf4",
"project_id" : "15645222e8744afa985c93dab6341da6",
"region_id" : "xxx",
"source_type" : 1
},
"environment" : {
"domain_id" : "ac7438b990ef4a37b741004eb45e8bf4",
"project_id" : "15645222e8744afa985c93dab6341da6",
"region_id" : "xxx",
"vendor_type" : "xxx"
},
"verdict" : "Black",
"name" : "test",
"status" : "Open"
},
"dataclass_ref" : {
"id" : "97ccf890-7480-31f6-a961-cf8da1f2f040",
"name" : "name"
},
"id" : "ff61d1f8-0de4-4077-9e9b-e312f6829c6d",
"update_time" : "2023-07-24T20:54:19Z+0800"
} ],
"message" : "",
"total" : 2
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功响应信息 |
|
400 |
请求失败响应信息 |
错误码
请参见错误码。