查询告警事件历史处置记录列表 - ListEventHandleHistory
功能介绍
查询告警事件历史处置记录列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/event/handle-history
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
severity |
否 |
String |
威胁等级,包含如下:
|
|
attack_tag |
否 |
String |
攻击标识,包含如下:
|
|
asset_value |
否 |
String |
资产重要性,包含如下3种
|
|
event_class_ids |
否 |
Array of strings |
事件标识,包含如下:
|
|
event_name |
否 |
String |
告警名称 |
|
event_type |
否 |
Integer |
参数解释: 事件类型 取值范围:
|
|
host_name |
否 |
String |
参数解释: 服务器名称 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
handle_status |
否 |
String |
处置状态,包含如下:
|
|
host_ip |
否 |
String |
参数解释: 服务器IP 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
limit |
是 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
offset |
是 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 不涉及 |
|
public_ip |
否 |
String |
服务器公网IP |
|
private_ip |
否 |
String |
参数解释: 服务器私有IP 约束限制: 不涉及 取值范围: 字符长度1-128位 默认取值: 不涉及 |
|
sort_dir |
否 |
String |
排序顺序,若sort_key不为空,设置返回结果按照sort_key升序或降序排序,默认降序排序,包含如下:
|
|
sort_key |
否 |
String |
排序字段,包含如下:
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释: 总数 取值范围: 最小值0,最大值2147483647 |
|
data_list |
Array of EventHandleHistory objects |
告警事件历史处置记录 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
event_type |
Integer |
事件类型 |
|
host_name |
String |
主机名称 |
|
event_abstract |
String |
事件摘要 |
|
attack_tag |
String |
攻击标识,包含如下:
|
|
private_ip |
String |
参数解释: 服务器私有IP 取值范围: 字符长度1-128位 |
|
public_ip |
String |
参数解释: 弹性公网IP地址 取值范围: 字符长度1-256位 |
|
asset_value |
String |
资产重要性,包含如下:
|
|
occur_time |
Integer |
参数解释: 发生时间,毫秒 取值范围: 最小值0,最大值9223372036854775807 |
|
handle_status |
String |
参数解释: 处理状态 取值范围:
|
|
notes |
String |
备注 |
|
event_class_id |
String |
参数解释: 事件分类 取值范围:
|
|
event_name |
String |
事件名称 |
|
handle_time |
Integer |
参数解释: 处置时间,毫秒,已处理的告警才有 取值范围: 最小值0,最大值9223372036854775807 |
|
operate_type |
String |
参数解释: 处理方式 取值范围:
|
|
severity |
String |
参数解释: 威胁等级 取值范围:
|
|
user_name |
String |
用户名 |
请求示例
无
响应示例
状态码:200
请求已成功
{
"total_num" : 23081,
"data_list" : [ {
"event_class_id" : "graph_0001",
"event_name" : "检测到可疑样本执行",
"user_name" : "scc_hss_g0***0938_01",
"operate_type" : "do_not_ignore",
"host_name" : "ecs-00****74-windows",
"attack_tag" : "collapsible_host",
"private_ip" : "192.168.0.180",
"public_ip" : "100.93.15.94",
"asset_value" : "common",
"severity" : "Critical",
"occur_time" : 1737511632000,
"handle_status" : "unhandled",
"notes" : "本次处理了1个告警,作为记录便于查看。",
"handle_time" : 1737532947313
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。