GET-获取事件列表

介绍获取事件列表接口的接口调用方式。

接口介绍

获取事件列表接口用于获取包含所有安全违规事件的列表。

获取事件列表后，后续可以通过获取事件详情接口查询某个事件的详细信息。具体查阅获取事件详情。

请求方式

GET

接口地址

https://<ucwi_endpoint>:5443/skg/v1/dlp/incident?<事件属性>
注： 你可以使用GET-获取事件详情接口查看某一事件的详细信息。

请求参数

参数名称 参数位置 是否必须 描述
authorization header 是 请求中的认证信息。查阅章节获取详细信息认证。
x-skg-timestamp header 是 当前的Timestamp。查阅章节获取详细信息认证。
参数名称 参数位置 是否必须 描述
<事件属性> URL参数 是 事件属性可以简单地仅指定一个通道类型，如web、email或者webserviceapp，即可将所有该类型下的违规事件列出。使用获取通道接口查看所有通道类型。

事件属性提供了多个参数做更细致地查询，具体参数参考下面的列表。
事件属性参数列表如下：
  • page_from(可选)：事件分页起始页(默认为0)
  • page_sizetype(可选)：每页返回的事件数目(1对应20个事件，2对应50个事件，3对应100个事件。默认为1)
  • start_timestamp(可选)：事件开始时间 epoch timestamp
  • end_timestamp(可选)：事件结束时间 epoch timestamp
  • user(可选)：生成事件的用户名
  • action(可选)：对违规事件所采取的动作：1 - 允许（审计模式） 2 - 阻断（阻断模式）
  • source(可选)：事件来源
  • dest(可选)： 事件目标
  • policy(可选)：策略名称
  • channel(可选)： 通道

Python请求示例

以下示例为使用Python代码调用接口，以请求获取事件列表的信息。

该示例旨在通过接口，获取从起始时间戳为1484895553到结束时间戳为1484896943期间，用户joe.doe@abc.com被阻断的所有事件。

import requests
auth_headers = {
    "Authorization": "<Authorization>",
    "x-skg-timestamp": "<timestamp>",
}
ucwi_endpoint = "<ENDPOINT>"
url = ucwi_endpoint + "/skg/v1/dlp/incident?start_timestamp=1484895553&end_timestamp=1484896943&user=abc\joe.
doe&action=2"
r = requests.get(url, headers=auth_headers)
print(r.json())

返回结果

返回结果中包含以下参数：
名称 描述
result 请求是否成功，成功为0，失败为1
incidents 安全违规事件的事件ID号
errorCode 请求失败时返回的错误代码
message 请求失败时返回的错误消息

以上事件列表请求结果如下：

  • 请求成功：
    {
"result" : 0,
"incidents" : ["d829cb60-1571-4c72-b2c4-3de461698b73", "912ed858-2a6d-4faaa41e-debccf9e163c"]
}
  • 请求失败：
    {
"result" : 1,
"errorCode" : 400,
"message" : "Invalid parameter"
}

错误代码

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