GET-获取事件详情

介绍获取事件详情接口的接口调用方式。

接口介绍

获取事件详情接口用于获取某一事件的详细信息。

请求方式

GET

接口地址

https://<ucwi_endpoint>:5443/skg/v1/dlp/incident/<事件ID>

请求参数

参数名称 参数位置 是否必须 描述
<事件ID> URL参数 指定事件的ID。通过获取事件列表获取各个违规事件的ID。GET-获取事件列表
参数名称 参数位置 是否必须 描述
authorization header 请求中的认证信息。查阅章节获取详细信息认证
x-skg-timestamp header 当前的Timestamp。查阅章节获取详细信息认证

Python请求示例

以下示例为使用Python代码调用接口,以请求获取事件详情信息。

该示例旨在调用接口,请求获取UUIDd829cb60-1571-4c72-b2c4-3de461698b73的事件的详细信息。

注: 在如下Python代码示例中,导入的Header文件ucwi_config ucwi_auth的需事先创建,如需详细参考示例,请参阅Header文件示例
# -*- coding: utf-8 -*-
from requests.packages.urllib3.exceptions import InsecureRequestWarning
from ucwi_config import UCWIConfig
from ucwi_auth import get_headers
import requests
import json

requests.packages.urllib3.disable_warnings(InsecureRequestWarning)

incident_uuid = "d829cb60-1571-4c72-b2c4-3de461698b73"
# 事件的UUID
api = "/skg/v1/dlp/incident/{}".format(incident_uuid)
url = "{0}{1}".format(UCWIConfig.base_url, api)

headers = get_headers()
response = requests.get(url, headers=headers, verify=False)
if response.status_code != 200:
    print("Bad request, response code:", response.status_code)
    print(response.text)
else:
    print(json.dumps(response.json(), indent=4).encode('utf-8').decode('raw_unicode_escape'))

返回结果

返回值包含:查询ID,检测时间,事件时间,来源,目标,策略名称,通道,动作,事件状态,安全级别,最大匹配,和文件名称。

返回值参数定义如下表所示:

参数名 类型 含义
queryID String 查询ID,此ID与发送内容检查中metadata中传送的查询ID一致。queryid的值为第三方云服务中的流量ID。
forensicsName String 证据文件名称
detectTime int 监测时间戳
incidentTime int 生成事件事件戳
source String 生成事件源 - 如用户IP或用户名
dest Array 生成事件目的 - 如用户访问网站或收件人列表。WebService应用通道无此项。
action int 1 - 放行, 2- 阻断
channel String 通道
policies Array 配备策略名
incidentStatus int 1- 新事件, 2 - 进行中, 3 - 关闭, 4 - 误报, 5 - 提级 (可通过WebUI修改事件状态)
severityTypeCode int 1 - 高, 2 - 中, 3 - 低, 4 - 信息
maxMatches int 最大匹配数

返回示例

事件详情请求返回值案例:

  • 请求成功:
    {
    "result" : 0,
    "data" : {
    "queryID" : "d829cb60-1571-4c72-b2c4-3de461698b73",
    "forensicsName" : "76c68a52-dff3-47e0-b992-a3186fad2134.eml"
    "detectTime" : 1484896943,
    "incidentTime": 1484896943,
    "source" : ["abc\joe.doe"],
    "dest" : ["www.baidu.com"],
    "action" : 1/2,
    "channel" : "http",
    "policies" : ["test"],
    "incidentStatus" : 1/2/3/4/5,
    "severityTypeCode": 1/2/3/4,
    "maxMatches": 10
    }
    }
  • 请求失败
    {
    "result" : 1,
    "errorCode" : 400,
    "message" : "Invalid parameter"
    }

错误代码

若调用出现错误,将返回以下错误代码:
错误码 描述
400 无效参数
404 未知错误,例如请求了未触发的事件等。
500 无效参数