安全云脑 SECMASTER-搜索告警列表:响应参数

时间:2023-12-06 18:52:41

响应参数

状态码: 200

表8 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表9 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度:0

最大长度:64

message

String

错误信息

最小长度:0

最大长度:1024

total

Integer

告警总数

最小值:0

最大值:10000

limit

Integer

分页大小

最小值:0

最大值:10000

offset

Integer

偏移量

最小值:0

最大值:10000

success

Boolean

是否成功

data

Array of ListAlertDetail objects

告警列表

数组长度:0 - 10000

表10 ListAlertDetail

参数

参数类型

描述

data_object

ListAlertRsp object

告警详情

create_time

String

Create time

最小长度:0

最大长度:64

update_time

String

Update time

最小长度:0

最大长度:64

project_id

String

Id value

最小长度:32

最大长度:64

workspace_id

String

Id value

最小长度:32

最大长度:64

id

String

The name, display only

最小长度:0

最大长度:1024

type

String

The name, display only

最小长度:0

最大长度:1024

version

Integer

The name, display only

最小值:0

最大值:1024

format_version

Integer

The name, display only

最小值:0

最大值:1024

dataclass_ref

dataclass_ref object

dataclass对象

表11 ListAlertRsp

参数

参数类型

描述

version

String

版本

最小长度:1

最大长度:64

environment

environment object

环境信息

datasource

datasource object

数据源信息

first_observed_time

String

Update time

最小长度:0

最大长度:64

last_observed_time

String

Update time

最小长度:0

最大长度:64

create_time

String

Create time

最小长度:0

最大长度:64

arrive_time

String

Update time

最小长度:0

最大长度:64

title

String

The name, display only

最小长度:0

最大长度:1024

description

String

The description, display only

最小长度:0

最大长度:1024

source_url

String

事件URL链接

最小长度:1

最大长度:64

count

Integer

事件发生次数

最小值:0

最大值:5

confidence

Integer

置信度

最小值:0

最大值:5

serverity

String

严重性等级

最小长度:1

最大长度:64

criticality

Integer

关键性,是指事件涉及的资源的重要性级别。

最小值:0

最大值:5

alert_type

Object

事件分类

network_list

Array of network_list objects

network_list

数组长度:0 - 100

resource_list

Array of resource_list objects

network_list

数组长度:0 - 100

remediation

remediation object

补救措施

verification_state

String

验证状态

最小长度:1

最大长度:64

handle_status

String

事件处理状态

最小长度:1

最大长度:64

sla

String

sla

最小长度:0

最大长度:65535

update_time

String

Create time

最小长度:0

最大长度:64

close_time

String

Create time

最小长度:0

最大长度:64

chop_phase

String

周期/处置阶段编号

最小长度:4

最大长度:64

ipdrr_phase

String

周期/处置阶段编号

最小长度:4

最大长度:64

ppdr_phase

String

周期/处置阶段编号

最小长度:4

最大长度:64

simulation

String

是否为调试事件.

最小长度:0

最大长度:64

actor

String

委托人

最小长度:0

最大长度:64

owner

String

The name, display only

最小长度:0

最大长度:1024

cteator

String

The name, display only

最小长度:0

最大长度:1024

close_reason

String

关闭原因

最小长度:32

最大长度:64

close_comment

String

关闭原因

最小长度:0

最大长度:64

malware

malware object

恶意软件

system_info

Object

系统信息

process

Array of process objects

进程信息

数组长度:0 - 100

user_info

Array of user_info objects

用户信息

数组长度:0 - 100

file_info

Array of file_info objects

文件信息

数组长度:0 - 100

system_alert_table

Object

系统信息

id

String

Id value

最小长度:32

最大长度:64

workspace_id

String

workspace id

最小长度:32

最大长度:64

表12 environment

参数

参数类型

描述

vendor_type

String

The name, display only

最小长度:0

最大长度:1024

domain_id

String

Id value

最小长度:32

最大长度:64

region_id

String

Id value

最小长度:1

最大长度:64

project_id

String

Id value

最小长度:32

最大长度:64

表13 datasource

参数

参数类型

描述

source_type

Integer

current page count

最小值:0

最大值:9999

domain_id

String

Id value

最小长度:32

最大长度:64

project_id

String

Id value

最小长度:32

最大长度:64

region_id

String

Id value

最小长度:1

最大长度:64

表14 network_list

参数

参数类型

描述

direction

Object

方向,取值范围:IN | OUT

protocol

String

协议,参考:IANA registered name

最小长度:1

最大长度:64

src_ip

String

源IP地址

最小长度:0

最大长度:64

src_port

Integer

源端口,0–65535

最小值:0

最大值:65535

src_domain

String

域名 ,最大128个字符

最小长度:0

最大长度:128

dest_ip

String

目的IP地址

最小长度:0

最大长度:64

dest_port

String

目的端口,0–65535

最小长度:0

最大长度:64

dest_domain

String

目的域名,最大128个字符

最小长度:0

最大长度:128

src_geo

Object

源IP的地理位置信息

dest_geo

Object

目的IP的地理位置信息

表15 resource_list

参数

参数类型

描述

id

String

Id value

最小长度:32

最大长度:64

name

String

The name, display only

最小长度:0

最大长度:1024

type

String

The name, display only

最小长度:0

最大长度:1024

domain_id

String

Id value

最小长度:32

最大长度:64

project_id

String

Id value

最小长度:32

最大长度:64

region_id

String

Id value

最小长度:0

最大长度:64

ep_id

String

Id value

最小长度:0

最大长度:64

ep_name

String

The name, display only

最小长度:0

最大长度:1024

tags

String

Id value

最小长度:0

最大长度:64

表16 remediation

参数

参数类型

描述

recommendation

String

The name, display only

最小长度:0

最大长度:1024

url

String

The name, display only

最小长度:0

最大长度:1024

表17 malware

参数

参数类型

描述

malware_family

String

恶意家族

最小长度:0

最大长度:64

malware_class

String

恶意软件分类

最小长度:0

最大长度:64

表18 process

参数

参数类型

描述

process_name

String

The name, display only

最小长度:0

最大长度:1024

process_path

String

The name, display only

最小长度:0

最大长度:1024

process_pid

Integer

Id value

最小值:1

最大值:2147483647

process_uid

Integer

Id value

最小值:1

最大值:2147483647

process_cmdline

String

The name, display only

最小长度:0

最大长度:1024

表19 user_info

参数

参数类型

描述

user_id

String

Id value

最小长度:0

最大长度:64

user_name

String

The name, display only

最小长度:0

最大长度:1024

表20 file_info

参数

参数类型

描述

file_path

String

The name, display only

最小长度:0

最大长度:1024

file_content

String

The name, display only

最小长度:0

最大长度:1024

file_new_path

String

The name, display only

最小长度:0

最大长度:1024

file_hash

String

The name, display only

最小长度:0

最大长度:1024

file_md5

String

The name, display only

最小长度:0

最大长度:1024

file_sha256

String

The name, display only

最小长度:0

最大长度:1024

file_attr

String

The name, display only

最小长度:0

最大长度:1024

表21 dataclass_ref

参数

参数类型

描述

id

String

Id value

最小长度:32

最大长度:64

name

String

The name, display only

最小长度:0

最大长度:1024

状态码: 400

表22 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表23 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度:0

最大长度:64

message

String

错误描述

最小长度:0

最大长度:1024

support.huaweicloud.com/api-secmaster/ListAlerts.html