createReport

该方法根据接收的参数创建新的即时或定时报告，并返回新生成报告的ID。

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

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

服务

此方法要求您将 {service} 名称置于API URL中。允许的服务包括：

computers （对应"计算机与虚拟机"）
virtualmachines （对应"虚拟机"）

例如，针对 虚拟机 服务的请求URL为：

https://YOUR-HOSTNAME/api/v1.0/jsonrpc/reports/virtualmachines

参数

参数	类型	可选	描述
`name`	字符串	否	报告名称。
`type`	数值	否	报告类型。可传入以下值之一：
`targetIds`	数组	否	目标ID列表，用于创建报告的目标对象。目标取决于报告类型。对于以下报告，目标只能是用户公司的ID或子公司的ID：客户状态概览 AWS月度使用量感染最严重的10家公司其他报告类型的目标ID可以是任意类型：组、公司、容器、端点。
`scheduledInfo`	对象	是	定义报告运行计划的对象。若省略该参数，则生成即时报告。详情请参阅 scheduledInfo 对象说明。
`options`	对象	是	定义报告创建选项的对象。对于以下报告，该 `选项` 对象不应设置：终端模块状态策略合规性安全服务器状态升级状态更多信息请查阅选项对象的详细信息。
`邮件列表`	数组	是	用于接收报告的电子邮件地址列表。 `邮件列表` 不适用于即时报告。仅当请求中包含 `计划信息` 参数时方可使用此参数。

对象

计划信息

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

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

名称	类型	描述
`发生频率`	整数	该成员为必填项。可选值： 1 - 即时报告注意该值仅在请求中未包含 `scheduledInfo` 参数时可用。 2 - 每小时报告 3 - 每日报告 4 - 每周报告 5 - 每月报告 6 - 每年报告
`间隔`	整数	该成员仅在 `occurrence` 值为2时需设置。可选值： 1至24之间的任意整数，表示报告运行的间隔（小时）。
`起始小时`	整数	该成员仅在 `occurrence` 值为3、4或5时需设置。可选值： 0至23之间的任意整数。
`起始分钟`	整数	该成员仅在 `occurrence` 值为3、4或5时需设置。可选值： 0至59之间的任意整数。
`天数`	数组	仅当 `occurrence` 取值为4时应设置此成员。数组元素的可选值： 0至6之间的整数，表示星期几，从0（周日）到6（周六）。
`日`	整数	仅当 `occurrence` 取值为5或6时应设置此成员。可选值： 1至31之间的整数，表示月份中的日期。
`月份`	整数	仅当 `occurrence` 取值为6时应设置此成员。可选值： 1至12之间的整数，表示年份中的月份。

选项

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

反钓鱼活动

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

名称	类型	描述
`reportingInterval`	整数	该成员为必填项。此值取决于报告 `occurrence` 。更多信息请参阅报告间隔与重复频率的关系 .
`filterType`	整数	该成员为必填项。可选值： 0 - 所有终端 1 - 仅包含被拦截网站的终端

名称

类型

描述

reportingInterval

整数

该成员为必填项。

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

filterType

整数

该成员为必填项。

可选值：

0 - 所有终端
1 - 仅包含被拦截网站的终端

被拦截的应用程序

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

名称	类型	描述
`reportingInterval`	整数	该成员为必填项。此值取决于报告 `occurrence` 。更多信息请参阅报告间隔与重复频率的关系 .

名称

类型

描述

reportingInterval

整数

该成员为必填项。

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

被拦截的网站

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

名称

类型

描述

reportingInterval

整数

该成员为必填项。

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

filterType

整数

该成员为必填项。

可选值：

0 - 所有端点
1 - 仅含被屏蔽网站的端点

数据保护

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

名称	类型	描述
`reportingInterval`	整数	该成员为必填项。此值取决于报告 `occurrence` 。更多信息请参阅报告间隔与重复次数的关系 .
`filterType`	整数	该成员为必填项。可选值： 0 - 所有终端 1 - 仅包含存在拦截威胁的受管理计算机
`blockedEmails`	布尔值	仅当 `filterType` 取值为1时需设置此成员。可选值： `真` `假`
`blockedWebsites`	布尔值	仅当 `filterType` 取值为1时需设置此成员。可选值： `真` `假`

设备控制活动

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

名称	类型	描述
`reportingInterval`	整数	该成员为必填项。此值取决于报告 `出现频率` 。更多信息请参阅报告间隔与重复次数的关系 .

名称

类型

描述

reportingInterval

整数

该成员为必填项。

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

端点防护状态

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

名称	类型	描述
`过滤器类型`	整数	该成员为必填项。可选值： 0 - 所有端点 1 - 仅包含下文所述成员筛选的端点。
`防病毒开启`	布尔值	仅当 `过滤器类型` 取值为1时需设置此成员。可选值： `真` ，表示在报告中包含启用反恶意软件防护的端点。 `假` ，表示在报告中排除启用反恶意软件防护的端点。
`防病毒关闭`	布尔值	仅当 `filterType` 值为1。可选值： `True` ，表示在报告中包含反恶意软件保护已关闭的终端。 `False` ，表示在报告中排除反恶意软件保护已关闭的终端。
`updated`	boolean	仅当 `filterType` 值为1时才应设置此成员。可选值： `True` ，表示在报告中包含已更新的终端。 `False` ，表示在报告中排除已更新的终端。
`disabled`	boolean	仅当 `filterType` 值为1时才应设置此成员。可选值： `True` ，表示在报告中包含更新已关闭的终端。 `False` ，表示在报告中排除更新已关闭的终端。
`outdated`	boolean	仅当 `filterType` 其值为1。可选值： `True` ，表示在报告中包含过时的端点。 `False` ，表示在报告中排除过时的端点。
`online`	boolean	该成员仅在 `filterType` 值为1时设置。可选值： `True` ，表示在报告中包含在线端点。 `False` ，表示在报告中排除在线端点。
`offline`	boolean	该成员仅在 `filterType` 值为1时设置。可选值： `True` ，表示在报告中包含离线端点。 `False` ，表示在报告中排除离线端点。

防火墙活动

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

名称	类型	描述
`reportingInterval`	整数	该成员为必填项。该值取决于报告 `occurrence` 。更多信息请参阅报告间隔与重复次数的关系 .
`filterType`	整数	该成员为必填项。可选值： 0 - 所有终端 1 - 仅包含以下被阻止威胁的终端：流量尝试和端口扫描。
`trafficAttempts`	布尔值	仅当filterType值为1时才需设置此成员。可选值： `True` ，表示在报告中包含被阻止端口扫描的终端。 `False` ，表示在报告中排除被阻止端口扫描的终端。

名称

类型

描述

reportingInterval

整数

该成员为必填项。

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

filterType

整数

该成员为必填项。

可选值：

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

trafficAttempts

布尔值

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

可选值：

True ，表示在报告中包含被阻止端口扫描的终端。
False ，表示在报告中排除被阻止端口扫描的终端。

恶意软件状态

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

名称	类型	描述
`reportingInterval`	整数	该成员为必填项。该值取决于报告 `发生频率` 。更多信息请参阅报告间隔与重复发生的关系 .
`筛选类型`	整数	该成员为必填项。可选值： 0 - 所有终端 1 - 仅仍受感染的终端
`详细导出`	数组	该成员为可选项。可选值： 1 - 在PDF文件中包含终端恶意软件状态

名称

类型

描述

reportingInterval

整数

该成员为必填项。

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

筛选类型

整数

该成员为必填项。

可选值：

0 - 所有终端
1 - 仅仍受感染的终端

详细导出

数组

该成员为可选项。

可选值：

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

网络状态

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

名称	类型	描述
`筛选类型`	整数	该成员为必填项。可选值： 0 - 所有终端 1 - 仅存在问题的终端 2 - 仅状态未知的终端

名称

类型

描述

筛选类型

整数

该成员为必填项。

可选值：

0 - 所有终端
1 - 仅存在问题的终端
2 - 仅状态未知的终端

按需扫描

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

名称	类型	描述
`报告间隔`	整数	该成员为必填项。此值取决于报告 `出现频率` 。更多信息请参阅报告间隔与重复频率的关系 .

名称

类型

描述

报告间隔

整数

该成员为必填项。

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

安全审计

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

名称	类型	描述
`报告间隔`	整数	该成员为必填项。此值取决于报告 `出现频率` 。更多信息请参阅报告间隔与重复频率的关系 .

名称

类型

描述

报告间隔

整数

该成员为必填项。

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

检测到的十大恶意软件

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

名称	类型	描述
`报告间隔`	整数	该成员为必填项。此值取决于报告 `发生频率` 。更多信息请参阅报告间隔与重复频率的关系 .

名称

类型

描述

报告间隔

整数

该成员为必填项。

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

感染终端Top10

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

名称	类型	描述
`报告间隔`	整数	该成员为必填项。此值取决于报告 `发生频率` 。更多信息请参阅报告间隔与重复频率的关系 .

名称

类型

描述

报告间隔

整数

该成员为必填项。

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

更新状态

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

名称	类型	描述
`已更新`	布尔值	可选值： `真` ，以在报告中包含已更新的端点。 `假` ，以在报告中排除已更新的端点。
`禁用`	布尔型	可选值： `真` ，以在报告中包含更新被禁用的端点。 `假` ，以在报告中排除更新被禁用的端点。
`过时`	布尔型	可选值： `真` ，以在报告中包含过时的端点。 `假` ，以在报告中排除过时的端点。
`待重启`	布尔型	可选值： `真` ，以在报告中包含需要重启的端点。 `假` ，以在报告中排除需要重启的端点。

虚拟机网络保护状态

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

名称	类型	描述
`filterType`	整数	该成员为必填项。可选值： 0 - 所有端点 1 - 仅受保护端点

名称

类型

描述

filterType

整数

该成员为必填项。

可选值：

0 - 所有端点
1 - 仅受保护端点

HyperDetect活动

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

名称	类型	描述
`reportingInterval`	整数	该成员为必填项。该值取决于报告 `occurrence` 。更多信息请参阅报告间隔与重复频率的关系 .

名称

类型

描述

reportingInterval

整数

该成员为必填项。

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

网络补丁状态

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

名称	类型	描述
`filterType`	整数	可选值： 0 - 所有可用补丁 1 - 仅补丁清单中可见的补丁

沙箱分析器提交失败

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

名称	类型	描述
`报告间隔`	整数	该成员为必填项。此数值取决于报告 `发生频率` 。更多信息请参阅报告间隔与重复频率的关系 .

名称

类型

描述

报告间隔

整数

该成员为必填项。

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

网络事件

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

名称	类型	描述
`报告间隔`	整数	该成员为必填项。此数值取决于报告 `发生频率` 。更多信息请参阅报告间隔与重复频率的关系 .

名称

类型

描述

报告间隔

整数

该成员为必填项。

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

完整性监控活动

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

名称	类型	描述
`reportingInterval`	整数	该成员为必填项。此值取决于报告 `occurrence` 。更多信息请参阅报告间隔与重复频率的关系 .

名称

类型

描述

reportingInterval

整数

该成员为必填项。

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

完整性监控配置变更

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

名称	类型	描述
`reportingInterval`	整数	该成员为必填项。此值取决于报告 `occurrence` 。更多信息请参阅报告间隔与重复频率的关系 .

名称

类型

描述

reportingInterval

整数

该成员为必填项。

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

重要提示

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

终端模块状态
策略合规性
安全服务器状态
终端加密状态

报告间隔与重复频率的关系

occurrence	报告间隔
2 - 每小时报告	可选值： 0 - 今日
3 - 每日报告	可选值： 0 - 今日 1 - 上一天 2 - 本周
4 - 每周报告	可选值： 0 - 今日 1 - 上一天 2 - 本周 3 - 上周 4 - 本月
5 - 每月报告	可选值： 0 - 今日 1 - 上一天 2 - 本周 3 - 上周 4 - 本月 5 - 上月 6 - 过去2个月 7 - 过去3个月 8 - 今年
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"
  }

本节内容 :

createReport

服务

参数

对象

计划信息

注意

选项

重要提示

报告间隔与重复频率的关系

返回值

示例

搜索结果