处理告警事件 - ChangeEvent
功能介绍
处理告警事件
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/event/operate
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
主机所属的企业项目ID。 开通企业项目功能后才需要配置企业项目。 企业项目ID默认取值为“0”,表示默认企业项目。如果需要查询所有企业项目下的主机,请传参“all_granted_eps”。如果您只有某个企业项目的权限,则需要传递该企业项目ID,查询该企业项目下的主机,否则会因权限不足而报错。 |
|
container_name |
否 |
String |
容器实例名称 |
|
container_id |
否 |
String |
容器Id |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
|
region |
否 |
String |
Region ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
operate_type |
是 |
String |
参数解释: 处理方式 取值范围:
|
|
handler |
否 |
String |
参数解释: 备注信息,已处理的告警才有 取值范围: 字符长度1-256位 |
|
operate_event_list |
是 |
Array of OperateEventRequestInfo objects |
操作的事件列表 |
|
event_white_rule_list |
否 |
Array of EventWhiteRuleListRequestInfo objects |
用户自定义告警白名单规则列表 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
event_class_id |
是 |
String |
参数解释: 事件分类 取值范围:
|
|
event_id |
是 |
String |
参数解释: 事件ID 取值范围: 字符长度1-64位 |
|
event_type |
是 |
Integer |
参数解释: 事件类型 取值范围:
|
|
occur_time |
是 |
Integer |
参数解释: 发生时间,毫秒 取值范围: 最小值0,最大值9223372036854775807 |
|
operate_detail_list |
是 |
Array of EventDetailRequestInfo objects |
操作详情信息列表,当operate_type为add_to_alarm_whitelist或remove_from_alarm_whitelist时,必传keyword和hash;当operate_type为add_to_login_whitelist或remove_from_login_whitelist时,必传login_ip,private_ip和login_user_name;当operate_type为isolate_and_kill或do_not_isolate_or_kill时,必传agent_id,file_hash,file_path,process_pid;其余情况可不填写内容。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
agent_id |
否 |
String |
参数解释: Agent ID 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
process_pid |
否 |
Integer |
参数解释: 进程ID 取值范围: 最小值0,最大值2147483647 |
|
file_hash |
否 |
String |
参数解释: 文件哈希 取值范围: 字符长度1-256位 |
|
file_path |
否 |
String |
参数解释: 文件路径 取值范围: 字符长度1-256位 |
|
file_attr |
否 |
String |
参数解释: 文件属性 取值范围: 字符长度1-256位 |
|
keyword |
否 |
String |
参数解释: 告警事件关键字,仅用于告警白名单 取值范围: 字符长度1-256位 |
|
hash |
否 |
String |
参数解释: 告警事件hash,仅用于告警白名单 取值范围: 字符长度1-256位 |
|
private_ip |
否 |
String |
参数解释: 服务器私有IP 取值范围: 字符长度1-128位 |
|
login_ip |
否 |
String |
参数解释: 登录源IP 取值范围: 字符长度1-256位 |
|
login_user_name |
否 |
String |
参数解释: 登录用户名 取值范围: 字符长度1-256位 |
|
container_id |
否 |
String |
容器ID |
|
container_name |
否 |
String |
容器名称 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
event_type |
是 |
Integer |
参数解释: 事件类型 取值范围:
|
|
field_key |
是 |
String |
参数解释: 加白字段 取值范围:
|
|
field_value |
是 |
String |
加白字段值 |
|
judge_type |
是 |
String |
参数解释: 通配符 取值范围:
|
响应参数
状态码:200
请求已成功
无
请求示例
手动处理告警事件类型为Rootkit、告警事件编号为2a71e1e2-60f4-4d56-b314-2038fdc39de6的入侵告警事件。
POST https://{endpoint}/v5/{project_id}/event/operate?enterprise_project_id=xxx
{
"operate_type" : "mark_as_handled",
"handler" : "test",
"operate_event_list" : [ {
"event_class_id" : "rootkit_0001",
"event_id" : "2a71e1e2-60f4-4d56-b314-2038fdc39de6",
"occur_time" : 1672046760353,
"event_type" : 1010,
"operate_detail_list" : [ {
"agent_id" : "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8",
"file_hash" : "e8b50f0b91e3dce0885ccc5902846b139d28108a0a7976c9b8d43154c5dbc44d",
"file_path" : "/usr/test",
"process_pid" : 3123,
"file_attr" : 33261,
"keyword" : "file_path=/usr/test",
"hash" : "e8b50f0b91e3dce0885ccc5902846b139d28108a0a7976c9b8d43154c5dbc44d",
"login_ip" : "127.0.0.1",
"private_ip" : "127.0.0.2",
"login_user_name" : "root",
"container_id" : "containerid",
"container_name" : "/test"
} ]
} ]
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。