跳至主内容

createReport

此方法根据接收的参数创建新的即时或计划报告，并返回新创建报告的ID。

即时报告在API调用时创建并仅运行一次。

计划报告稍后创建，并根据预定义的时间表定期运行。

参数

参数

类型

可选

描述

名称

字符串

否

报告名称。

类型

数字

否

报告类型。可传递以下值之一：

  • 1 - 反钓鱼活动

  • 2 - 被阻止的应用程序

  • 3 - 被阻止的网站

  • 4 - 客户状态概览

  • 5 - 数据保护

  • 6 - 设备控制活动

  • 7 - 终端模块状态

  • 8 - 终端防护状态

  • 9 - 防火墙活动

  • 10 - 许可证状态

  • 12 - 恶意软件状态

  • 13 - 月度许可证使用情况

  • 14 - 网络状态

  • 15 - 按需扫描

  • 16 - 策略合规性

  • 17 - 安全审计

  • 18 - 安全服务器状态

  • 19 - 检测到的前10大恶意软件

  • 20 - 感染最严重的前10家公司

  • 21 - 感染最严重的前10个终端

  • 22 - 更新状态

  • 23 - 升级状态

  • 24 - AWS月度使用情况

  • 29 - 电子邮件安全使用情况

  • 30 - 终端加密状态

  • 31 - HyperDetect活动

  • 32 - 网络补丁状态

  • 33 - 沙盒分析器提交失败记录

  • 34 - 网络事件

  • 35 - MDR服务状态

  • 36 - 完整性监控活动

  • 37 - 完整性监控配置变更

  • 38 - 移动安全月度许可证使用情况

  • 39 - 数据洞察许可证使用情况

目标ID列表

数组

否

用于生成报告的目标ID列表。目标类型取决于报告类型。对于以下报告，目标只能是用户公司ID或子公司ID：

  • 客户状态概览

  • 许可证状态

  • 月度许可证使用情况

  • AWS月度使用情况

  • 感染最严重的10家公司

  • MDR服务状态

  • 邮件安全月度许可证使用情况

  • 移动安全月度许可证使用情况

其他报告类型的目标ID可以是任意类型：组、公司、容器或终端。

计划信息

对象

是

定义报告运行计划的对象。若省略该参数，则生成即时报告。详细信息请参阅 计划信息 对象说明。

选项

对象

是

定义创建报告选项的对象。对于这些报告， 选项 对象不应设置：

  • 终端模块状态

  • 许可证状态

  • 策略合规性

  • 安全服务器状态

  • 升级状态

  • MDR服务状态

更多信息请查阅 选项 对象的详细信息。

邮件列表

数组

是

用于接收报告的电子邮件地址列表。 邮件列表 不适用于即时报告。

仅当请求中包含 计划信息 参数时方可使用此参数。

对象

计划信息

该对象由 createReport 调用使用，用于定义报告运行的调度规则。

该对象包含可变数量的成员，具体取决于报告的执行频率：

名称

类型

描述

出现频率

整数

该成员为必填项。

可选值：

  • 1 - 即时报告

    注意

    该值仅在请求中未包含 scheduledInfo 参数时可用。

  • 2 - 每小时报告

  • 3 - 每日报告

  • 4 - 每周报告

  • 5 - 每月报告

  • 6 - 年度报告

对于 13-月度许可证使用情况 和 24-AWS月度使用情况 报告，可选值仅为 4-每周报告 和 5-每月报告。

对于 29-电子邮件安全使用情况 和 38-移动安全月度许可证使用情况 报告，可选值仅为 5-每月报告 和 6-年度报告 .

interval

整数

该成员仅在以下情况下应设置 occurrence 的值为2时。

可能取值：

  • 1至24之间的任意整数，表示报告运行的间隔（小时）。

startHour

整数

该成员仅在以下情况下应设置 occurrence 的值为3、4或5时。

可能取值：

  • 0至23之间的任意整数。

startMinute

整数

该成员仅在以下情况下应设置 occurrence 的值为3、4或5时。

可能取值：

  • 0至59之间的任意整数。

days

数组

该成员仅在以下情况下应设置 occurrence 的值为4时。

数组元素的可能取值：

  • 0至6之间的整数，表示星期几，从0（星期日）到6（星期六）。

day

integer

仅当 occurrence 取值为5或6时才应设置该成员。

可能取值：

  • 1至31之间的整数，表示月份中的日期。

month

integer

仅当 occurrence 取值为6时才应设置该成员。

可能取值：

  • 1至12之间的整数，表示年份中的月份。

options

该对象由 createReport 调用使用，并根据报告类型包含可变数量的成员：

  • 反钓鱼活动

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    integer

    该成员为必填项。

    该值取决于报告 occurrence 。更多信息请参阅 报告间隔与重复频率的关系 .

    filterType

    整数

    该成员为必填项。

    可选值：

    • 0 - 所有端点

    • 1 - 仅含被屏蔽网站的端点

  • 被屏蔽的应用

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    该值取决于报告 发生频率 。更多信息请参阅 报告间隔与复发频率的关系 .

  • 被屏蔽的网站

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    该值取决于报告 发生频率 更多信息请参阅 报告间隔与重复发生之间的关系 .

    filterType

    整数

    该成员为必填项。

    可选值：

    • 0 - 所有端点

    • 1 - 仅含被屏蔽网站的端点

  • 客户状态概览

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    此值取决于报告 发生情况 。更多信息请参阅 报告间隔与重复发生之间的关系 .

  • 数据保护

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    该值取决于报告 发生频率 。更多信息请参阅 报告间隔与重复发生的关系 .

    filterType

    整数

    该成员为必填项。

    可选值：

    • 0 - 所有终端

    • 1 - 仅包含存在被拦截威胁的受管理计算机

    blockedEmails

    布尔值

    仅当 filterType 取值为1时需设置此成员。

    可选值：

    • 真

    • 假

    blockedWebsites

    布尔值

    仅当 filterType 取值为1时需设置此成员。

    可选值：

    • 真

    • 假

  • 设备控制活动

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    此值取决于报告 occurrence 。更多信息请参阅 报告间隔与重复频率的关系 .

  • 终端防护状态

    该对象必须包含以下成员：

    名称

    类型

    描述

    filterType

    整数

    该成员为必填项。

    可选值：

    • 0 - 所有终端

    • 1 - 仅包含下文所述成员筛选的终端。

    antivirusOn

    布尔值

    仅当 filterType 值为1时需设置此成员。

    可选值：

    • True ，表示在报告中包含启用反恶意软件防护的终端。

    • False ，从报告中排除已启用反恶意软件保护的端点。

    antivirusOff

    布尔值

    仅当 filterType 值为1时应设置此成员。

    可选值：

    • True ，在报告中包含反恶意软件保护已禁用的端点。

    • False ，从报告中排除反恶意软件保护已禁用的端点。

    updated

    布尔值

    仅当 filterType 值为1时应设置此成员。

    可选值：

    • True ，在报告中包含已更新的端点。

    • False ，从报告中排除已更新的端点。

    disabled

    布尔值

    仅当 filterType 值为1时应设置此成员。

    可选值：

    • True ，在报告中包含更新已禁用的端点。

    • False ，从报告中排除更新被禁用的端点。

    过时

    布尔值

    仅当 filterType 值为1时应设置该成员。

    可选值：

    • 真 ，在报告中包含过时的端点。

    • 假 ，从报告中排除过时的端点。

    在线

    布尔值

    仅当 filterType 值为1时应设置该成员。

    可选值：

    • 真 ，在报告中包含在线端点。

    • 假 ，从报告中排除在线端点。

    离线

    布尔值

    仅当 filterType 值为1时应设置该成员。

    可选值：

    • 真 ，在报告中包含离线端点。

    • 假 ，从报告中排除离线端点。

  • 防火墙活动

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    此值取决于报告 occurrence 。更多信息请参阅 报告间隔与重复频率的关系 .

    filterType

    整数

    该成员为必填项。

    可选值：

    • 0 - 所有端点

    • 1 - 仅包含以下被阻止威胁的端点：流量尝试和端口扫描。

    trafficAttempts

    布尔值

    仅当filterType值为1时需设置此成员。

    可选值：

    • True ，将包含被阻止端口扫描的端点至报告中。

    • False ，从报告中排除被阻止端口扫描的端点。

  • 恶意软件状态

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    该值取决于报告 发生情况 。更多信息请参阅 报告间隔与重复频率的关系 .

    filterType

    整数

    该成员为必填项。

    可选值：

    • 0 - 所有终端

    • 1 - 仅仍受感染的终端

    detailedExport

    数组

    该成员为可选项。

    可选值：

    • 1 - 在PDF文件中包含终端恶意软件状态

  • 月度许可证使用情况

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    该值取决于报告 发生频率 。更多信息请参阅 报告间隔与重复次数的关系 .

    skipSummary

    布尔值

    该成员为可选。

    用于定义月度许可证使用报告的CSV文件 (类型=13) 是否应包含摘要部分的选项。默认情况下，该参数设置为 False ，表示CSV文件包含摘要。

  • AWS月度使用情况

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    该值取决于报告 发生频率 。更多信息请参阅 报告间隔与重复次数的关系 .

  • 网络状态

    该对象必须包含以下成员：

    名称

    类型

    描述

    filterType

    整数

    该成员为必填项。

    可选值：

    • 0 - 所有端点

    • 1 - 仅存在问题的端点

    • 2 - 仅状态未知的端点

  • 按需扫描

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    该值取决于报告 出现频率 。更多信息请参阅 报告间隔与重复频率的关系 .

  • 安全审计

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    该值取决于报告 发生次数 。更多信息请参阅 报告间隔与重复发生之间的关系 .

  • 检测到的十大恶意软件

    该对象必须包含以下成员：

    名称

    类型

    描述

    报告间隔

    整数

    该成员为必填项

    该值取决于报告内容 发生次数 。更多信息请参阅 报告间隔与重复发生之间的关系 .

  • 受感染的十大企业

    该对象必须包含以下成员：

    名称

    类型

    描述

    报告间隔

    整数

    该成员为必填项

    该值取决于报告内容 发生次数 。更多信息请参阅 报告间隔与重复发生之间的关系 .

  • 感染最严重的10个端点

    该对象必须包含以下成员：

    名称

    类型

    描述

    报告间隔

    整数

    该成员为必填项。

    此值取决于报告 发生频率 。更多信息请参阅 报告间隔与发生频率的关系 .

  • 更新状态

    该对象必须包含以下成员：

    名称

    类型

    描述

    已更新

    布尔值

    可选值：

    • 真 ，表示将已更新的端点包含在报告中。

    • 假 ，表示将已更新的端点排除在报告外。

    禁用

    布尔值

    可选值：

    • 真 ，表示将更新被禁用的端点包含在报告中。

    • False ，从报告中排除更新被禁用的端点。

    outdated

    boolean

    可选值：

    • True ，在报告中包含过时的端点。

    • False ，从报告中排除过时的端点。

    pendingRestart

    boolean

    可选值：

    • True ，在报告中包含需要重启的端点。

    • False ，从报告中排除需要重启的端点。

  • 虚拟机网络保护状态

    该对象必须包含以下成员：

    名称

    类型

    描述

    filterType

    integer

    该成员为必填项。

    可选值：

    • 0 - 所有端点

    • 1 - 仅受保护的端点

  • 电子邮件安全使用情况

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    该值取决于报告 出现频率 。更多信息请参阅 报告间隔与重复频率的关系 .

  • HyperDetect活动

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    该值取决于报告 出现频率 。更多信息请参阅 报告间隔与重复频率的关系 .

  • 网络补丁状态

    该对象必须包含以下成员：

    名称

    类型

    描述

    filterType

    整数

    可选值：

    • 0 - 所有可用补丁

    • 1 - 仅补丁清单中可见的补丁

  • 沙盒分析器提交失败记录

    该对象必须包含以下成员：

    名称

    类型

    描述

    报告间隔

    整数

    该成员为必填项。

    该值取决于报告 出现频率 。更多信息请参阅 报告间隔与重复频率的关系 .

  • 网络事件

    该对象必须包含以下成员：

    名称

    类型

    描述

    报告间隔

    整数

    该成员为必填项。

    该值取决于报告 出现频率 。更多信息请参阅 报告间隔与重复频率的关系 .

  • 完整性监控活动

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    该值取决于报告 occurrence 。更多信息请参阅 报告间隔与重复发生的关系 .

  • 完整性监控配置变更

    该对象必须包含以下成员：

    名称

    类型

    描述

    reportingInterval

    整数

    该成员为必填项。

    该值取决于报告 occurrence 。更多信息请参阅 报告间隔与重复发生的关系 .

重要提示

以下报告不应设置该对象：

  • 端点模块状态

  • 许可证状态

  • 升级状态

  • 策略合规性

  • 安全服务器 状态

  • 终端加密状态

  • MDR服务状态

报告间隔与重复周期的关系

发生次数

报告间隔

2 - 每小时报告

可选值：

  • 0 - 今日

3 - 每日报告

可选值：

  • 0 - 今日

  • 1 - 上一天

  • 2 - 本周

4 - 每周报告

可选值：

  • 0 - 今日

  • 1 - 上一天

  • 2 - 本周

  • 3 - 上周

  • 4 - 本月

对于 13-月度许可证使用情况 , 24-AWS月度使用量 和 29-电子邮件安全使用情况 报告的可选值仅为 4-本月 .

5 - 月度报告

可能取值：

  • 0 - 今日

  • 1 - 昨日

  • 2 - 本周

  • 3 - 上周

  • 4 - 本月

  • 5 - 上月

  • 6 - 过去2个月

  • 7 - 过去3个月

  • 8 - 本年

对于 13-月度许可证使用情况 和 24-AWS月度使用情况 报告的可能取值仅为 4-周报 和 5-月报。 对于 29-电子邮件安全使用情况 报告的可能取值仅为 5-月报 和 6-年报 .

6 - 年度报告

可能取值：

  • 8 - 本年

  • 9 - 去年

返回值

此方法返回一个字符串：所创建报告的ID。

示例

请求 : 

{
       "params": {
           "name": "每小时报告",
           "type": 1,
           "targetIds": ["559bd17ab1a43d241b7b23c6",
                        "559bd17ab1a43d241b7b23c7"],
           "scheduledInfo": {
                "occurrence": 2,
                "interval": 4
            },
            "emailList": ["user@company.com",
                          "user2@company.com"]
       },
       "jsonrpc": "2.0",
       "method": "createReport",
       "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
  }

请求： 

{
       "params": {
           "name": "每日报告",
           "type": 8,
           "targetIds": ["559bd17ab1a43d241b7b23c6",
                        "559bd17ab1a43d241b7b23c7"],
           "scheduledInfo": {
                "occurrence": 3,
                "startHour": 10,
                "startMinute": 30
            },
            "options": {
                "filterType": 1,
                "antivirusOn": true,
                "antivirusOff": false,
                "updated": true,
                "disabled": false,
                "outdated": false,
                "online": false,
                "offline": true
            }
       },
       "jsonrpc": "2.0",
       "method": "createReport",
       "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
  }

响应 : 

{
      "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
      "jsonrpc":"2.0",
      "result": "563c78e2b1a43d4043d60413"
  }
本节内容 :