接口列表

罗列UCWI提供的WebService API。

统一内容安全审查平台UCWI提供的接口分为两类：资源获取接口和内容审查接口。

资源获取接口

接口名称 描述
GET-获取通道列表

/skg/v1/dlp/channel

 该接口用于获取所有通道类型。获取通道类型列表后，后续可以通过获取通道详细信息接口查询某个通道类型的详细信息。
GET-获取通道详情

/skg/v1/dlp/channel/<通道类型>

 该接口用于获取某个类型通道的详细信息。
GET-获取事件列表

/skg/v1/dlp/incident?<事件属性>

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

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

/skg/v1/dlp/incident/<事件ID>

该接口用于获取某一事件的详细信息。
GET-获取证据文件

/skg/v1/dlp/forensics/download?filename=<文件名称>.eml

 该接口用于发送请求获取证据文件。
GET-获取策略命中统计报告

/skg/v1/dlp/report?type=<报告类型>&top=<排名前几>

 发送请求以获取安全报告。

内容审查接口

接口名称 描述
POST-内容审查-Web通道

/skg/v1/dlp/channel/web/<协议类型>/<请求模式>

 对Web通道中的内容进行审查。
  • 该接口支持同步模式审查本地文件。
  • 该接口支持在异步模式下对存储在亚马逊S3、Swfit、阿里云OSS、腾讯云COS等云上的内容进行审查。
POST-内容审查-邮件通道

/skg/v1/dlp/channel/email/<协议类型>/<请求模式>

 对邮件通道中的内容进行审查。
  • 该接口支持同步模式审查本地文件。
  • 该接口支持在异步模式下对存储在亚马逊S3、Swfit、阿里云OSS、腾讯云COS等云上的内容进行审查。
POST-内容审查-WebService应用通道

/skg/v1/dlp/channel/webserviceapp/<WebService应用ID>/<请求模式>

 对WebService应用通道中的内容进行审查。
  • 该接口支持在同步模式下审查本地文件。
  • 针对文本内容的审查。相较于本地文件审查，文本内容减少了文件相关的请求参数，如md5值、是否进行病毒查杀等。
  • 该接口支持在异步模式下对存储在亚马逊S3、Swfit、阿里云OSS、腾讯云COS等云上的内容进行审查。
  • 该接口支持在异步模式下批量对S3、OSS、COS云存储内容进行审查。
POST-病毒检查

/skg/v1/swg/antivirus/<mode>

 对文本内容进行病毒查杀。
  • 该接口支持同步模式下对本地文件进行病毒检查。
  • 该接口支持在异步模式下对存储在亚马逊S3、Swfit、阿里云OSS、腾讯云COS等云上的内容进行病毒检查。