内容审查返回值介绍

介绍内容审查接口送检的返回值。若匹配策略,系统将返回匹配策略信息。

返回信息JSON参数

以下列表介绍内容审查返回值中的本地检测时间,即localDetectedTime的格式结构。
  • localDetectedTime: 检测时间
  • localDetectedTime.incident_info:事件信息
  • localDetectedTime.incident_info.matchedPolicies: 匹配策略
  • localDetectedTime.incident_info.matchedPolicies.numberOfMatches:匹配策略的事件数量
  • localDetectedTime.incident_info.matchedPolicies.name:匹配的策略名称
  • localDetectedTime.incident_info.matchedPolicies.actionSettingName:对违规事件执行的动作
  • localDetectedTime.incident_info.matchedPolicies.matchedRules:匹配的策略规则
以下列表介绍内容审查返回值中的匹配规则,即matchedRules的格式结构。
  • matchedRules.name:规则名称
  • matchedRules.matchedConditions:匹配的条件
  • matchedRules.matchedConditions.type:条件匹配类型, 包括: 正则、字典、外部脚本、文件类型组、关键字、脚本、文件指纹、机器学习、终端位置、文件名称、附件数量、数据库指纹、文件大小、二进制、压缩文件深度、加密文件、格式不匹配文件和内置模板。
  • matchedRules.matchedConditions.matchedElements: 匹配的元素
  • matchedRules.matchedConditions.matchedElements.matchedContents:匹配的内容
  • matchedRules.matchedConditions.matchedElements.matchedContents.detectedValues:检测到的内容
  • matchedRules.matchedConditions.matchedElements.matchedContents.isFileSuffixMatch:文件后缀名是否一致
  • matchedRules.matchedConditions.matchedElements.matchedContents.isEncryptFile: 是否为加密文件
  • matchedRules.matchedConditions.matchedElements.matchedContents.encodeType:文件编码类型, 具体请参阅国际标准编码类型及其解释
  • matchedRules.matchedConditions.matchedElements.matchedContents.numberOfMatches: 匹配数
  • matchedRules.matchedConditions.matchedElements.matchedContents.locationPath: 文件全路径
  • matchedRules.matchedConditions.matchedElements.matchedContents.isArchiveFile: 是否为压缩文件
  • matchedRules.matchedConditions.matchedElements.matchedContents.contentSize:内容大小
  • matchedRules.matchedConditions.matchedElements.numberOfMatches:匹配文件的数量
  • matchedRules.matchedConditions.isTraditionalMatching:是否开启繁体匹配
  • localDetectedTime.incident_info.matchedPolicies.actionSettingName:动作名称
  • localDetectedTime.incident_info.matchedPolicies.isTrickle:是否是零星式内容检测策略
  • localDetectedTime.incident_info.matchedPolicies.priority: 优先级
  • localDetectedTime.incident_info.matchedPolicies.groupName:策略组名称
  • localDetectedTime.incident_info.matchedPolicies.severity:敏感级别 1 - 高; 2 - 中; 3 - 低; 4 - 信息
  • localDetectedTime.result:返回结果
  • localDetectedTime.actionCode:可执行的动作代码, 包括:
    • 1:允许
    • 2:阻断
    • 3:确认
    • 4:删除附件
    • 5:邮件加密
    • 6:邮件隔离
    • 7:终端系统加密
    • 8:邮件内容加密
    • 9:终端个人密钥加密
    • 10:水印(仅限代理)

返回示例

以下示例为一送检返回值示例及具体注释。

{
"localDetectedTime":"2017-11-02T11:06:08.408697"        //检测时间
    "incident_info":                                    //事件信息
        {
            "matchedPolicies":[                         //匹配策略
                {
                    "numberOfMatches":1,                //匹配策略的事件数量
                    "name":"关键字策略",                 //匹配的策略名称
                    "actionSettingName":"阻断",           //对违规事件执行的动作
                    "matchedRules":[                    //匹配的策略规则
                        {
                            "name":"关键字策略",                     //规则名称
                            "matchedConditions":[                   //匹配的条件
                                {
                                    "type":5,                       //条件匹配类型, 包括: 1:正则, 2:字典, 3:外部脚本, 4:文件类型组, 5:关键字, 6:脚本, 7:文件指纹, 8:机器学习, 9:终端位置, 10:文件名称, 11:附件数量, 12:数据库指纹, 13:文件大小, 14:二进制, 15:压缩文件深度, 16:加密文件, 17:格式不匹配文件, 18:内置模板
                                    "matchedElements":[             //匹配的元素
                                        {
                                            "matchedContents":[     //匹配的内容
                                                {
                                                    "detectedValues":[  //检测到的内容
                                                        {"text":"保密"}   //关键字
                                                    ],
                                                    "isFileSuffixMatch":true,   //文件后缀名是否一致
                                                    "isEncryptFile":false,      //是否为加密文件
                                                    "encodeType":"UnknownEncoding", //文件编码类型, 具体请参阅国际标准编码类型及其解释
                                                    "numberOfMatches":1,            //匹配数
                                                    "locationPath":"DLP.rar|||DLP.docx",    //文件全路径
                                                    "isArchiveFile":false,          //是否为压缩文件
                                                    "contentSize":986637            //内容大小
                                                }
                                            ],
                                            "numberOfMatches":1,
                                        }
                                    ],
                                    "isTraditionalMatching":false       //是否开启繁体匹配
                                }
                            ]
                        }
                    ],
                    "isTrickle":false,      //是否是零星式内容检测策略
                    "priority":1001,        //优先级
                    "groupName":"默认策略组",    //策略组名称
                    "severity":4            //敏感级别 1 - 高, 2 - 中, 3 - 低, 4 - 信息
                },
                {
                    "numberOfMatches":2,
                    "name":"指纹策略",
                    "actionSettingName":"阻断",
                    "matchedRules":[
                        {
                            "name":"指纹规则",
                            "matchedConditions":[
                                {
                                    "type":7,
                                    "matchedElements":[
                                        {
                                            "matchedContents":[
                                                {
                                                    "detectedValues":[                      //当类型为文件指纹时没有text字段, 其他都有
                                                        {
                                                            "similarity":100,                   //相似度
                                                            "isPreciseMatching":false,          //是否为精确匹配
                                                            "filePath":"C:/Users/admin/Desktop/101/webserviceappfile/DLP.docx"       //文件指纹的原始扫描文件路径
                                                        },
                                                        {
                                                            "similarity":100,
                                                            "isPreciseMatching":true,
                                                            "filePath":"C:/Users/admin/Desktop/101/webserviceappfile/DLP.docx"
                                                        }
                                                    ],
                                                    "isFileSuffixMatch":true,
                                                    "isEncryptFile":false,
                                                    "encodeType":"UnknownEncoding",
                                                    "numberOfMatches":2,
                                                    "locationPath":"DLP.rar|||DLP.docx",
                                                    "isArchiveFile":false,
                                                    "contentSize":986637
                                                }
                                            ],
                                            "numberOfMatches":2,
                                        }
                                    ],
                                    "isTraditionalMatching":false
                                }
                            ]
                        }
                    ],
                    "isTrickle":false,
                    "priority":1001,
                    "groupName":"默认策略组",
                    "severity":1
                },
                {
                    "numberOfMatches":16,
                    "name":"关键字策略B",
                    "actionSettingName":"阻断",
                    "matchedRules":[
                        {
                            "name":"关键字规则",
                            "matchedConditions":[
                                {
                                    "type":5,
                                    "matchedElements":[
                                        {
                                            "matchedContents":[
                                                {
                                                    "detectedValues":[
                                                        {"text":"IP地址"},
                                                        {"text":"函数"},
                                                        {"text":"机器学习"}
                                                    ],
                                                    "isFileSuffixMatch":true,
                                                    "isEncryptFile":false,
                                                    "encodeType":"UnknownEncoding",
                                                    "numberOfMatches":16,
                                                    "locationPath":"DLP.rar|||DLP.docx",
                                                    "isArchiveFile":false,
                                                    "contentSize":986637
                                                }
                                            ],
                                            "numberOfMatches":16,
                                        }
                                    ],
                                    "isTraditionalMatching":false
                                }
                            ]
                        }
                    ],
                    "isTrickle":false,
                    "priority":1001,
                    "groupName":"默认策略组",
                    "severity":2
                }
            ]
        },
    "result":0,
    "actionCode":2, //可执行的动作代码, 包括-1:允许, 2:阻断, 3:确认, 4:删除附件, 5:邮件加密, 6:邮件隔离, 7:终端系统加密, 8:邮件内容加密, 9:终端个人密钥加密, 10:水印(仅限代理)
}