GET-获取策略命中统计报告
介绍获取策略命中统计报告的接口调用方式。
接口介绍
获取策略命中统计报告接口用于获取安全策略命中事件的统计报告。
请求方式
GET
接口地址
/skg/v1/dlp/report?type=<报告类型>&top=<排名前几>
请求参数
URL 参数列表如下:
- type:报告类型:1 - 策略命中排名 2 - 用户命中排名 3 - 目标命中排名 4 - 通道命中排名
- top:报告排名:前x名
| 参数名称 | 参数位置 | 是否必须 | 描述 |
|---|---|---|---|
| <报告类型> | URL参数 | 是 | 获取指定类型的报告。 |
| <排名前几> | URL参数 | 是 | 获取指定排名前几的统计信息。 |
Python请求示例
以下示例为使用Python代码调用接口,以请求策略命中统计的相关信息。
该案例旨在调用接口,请求获取策略命中排名前3名(top=3)的统计信息。
import requests
auth_headers = {
"Authorization": "<Authorization>",
"x-skg-timestamp": "<timestamp>",
}
ucwi_endpoint = "<ENDPOINT>"
url = ucwi_endpoint + "/skg/v1/dlp/report?type=1&top=3"
#统计前3名
r = requests.get(url, headers=auth_headers)
print(r.json())
返回结果
返回结果中包含以下参数:
| 名称 | 描述 |
|---|---|
| result | 请求是否成功,成功为0,失败为1 |
| report | 生成的安全报告 |
| name | 被违反的安全策略的名称 |
| incident_number | 违反该安全策略的事件号 |
| errorCode | 请求失败时返回的错误代码 |
| message | 请求失败时返回的错误消息 |
报告请求结果如下:
- 请求成功:
{ "result" : 0, "report" : [ { "name" : "policy1", "incident_number" : 20134 }, {"name" : "policy2", "incident_number" : 1097 }, { "name" : "policy3", "incident_number" : 198 } ] } - 请求失败:
{ "result" : 1, "errorCode" : 400, "message" : "Invalid parameter" }
错误代码
若调用出现错误,将返回以下错误代码:
| 错误码 | 描述 |
|---|---|
| 400 | 无效参数 |
| 404 | 未知错误,例如请求了未触发的事件等。 |
| 500 | 无效参数 |