createReport
该方法根据接收到的参数创建新的即时报告或定时报告，并返回新创建报告的ID。
即时报告在API调用时创建并仅运行一次。
定时报告将在稍后创建，并根据预定义计划定期运行。
参数
|
参数 |
类型 |
可选 |
描述 |
|---|---|---|---|
|
|
字符串 |
否 |
报告的名称。 |
|
|
数字 |
否 |
报告类型。可传入以下值之一：
|
|
|
数组 |
否 |
用于创建报告的目标ID列表。目标类型取决于报告类型。以下报告的目标只能是用户公司ID或子公司ID:
其他报告类型的目标ID可以是任意类型：组、公司、容器或终端。 |
|
|
对象 |
是 |
定义报告运行计划的对象。若省略该参数，则生成即时报告。更多信息请查阅 scheduledInfo 对象的详细说明。 |
|
|
Object |
是 |
定义报告创建选项的对象。对于以下报告，不应设置
更多信息请查阅 options 对象的详细说明。 |
|
|
数组 |
是 |
接收报告的电子邮件地址列表。
仅当请求中包含
|
对象
scheduledInfo
该对象由
createReport
调用，它定义了报告运行的调度计划。
该对象包含数量可变的成员，具体取决于报告的出现频率：
|
名称 |
类型 |
描述 |
|---|---|---|
|
|
整数 |
该成员为必填项。 可能取值：
对于
对于
|
|
|
整数 |
该成员仅在
可选值：
|
|
|
整数 |
该成员仅在
可选值：
|
|
|
整数 |
该成员仅在
可选值：
|
|
|
数组 |
仅当
数组元素的可能取值：
|
|
|
integer |
仅当
可能取值：
|
|
|
integer |
仅当
可能取值：
|
options
该对象由
createReport
调用使用，并根据报告类型包含可变数量的成员：
-
反钓鱼活动
该对象必须包含以下成员：
名称
类型
描述
reportingIntervalinteger
该成员为必填项。
此值取决于报告
发生频率。更多信息请参阅 报告间隔与重复次数的关系 .filterType整数
该成员为必填项。
可选值：
-
0 - 所有终端
-
1 - 仅含被屏蔽网站的终端
-
-
被屏蔽的应用程序
该对象必须包含以下成员：
名称
类型
描述
reportingInterval整数
该成员为必填项。
此值取决于报告
发生频率。更多信息请参阅 报告间隔与重复次数的关系 . -
被屏蔽的网站
该对象必须包含以下成员：
名称
类型
描述
reportingInterval整数
该成员为必填项。
此值取决于报告
发生频率。更多信息请参阅 报告间隔与重复频率的关系 .filterType整数
该成员为必填项。
可选值：
-
0 - 所有终端
-
1 - 仅包含被拦截网站的终端
-
-
数据保护
该对象必须包含以下成员：
名称
类型
描述
reportingInterval整数
该成员为必填项。
此值取决于报告
发生频率。更多信息请参阅 报告间隔与重复频率的关系 .filterType整数
该成员为必填项。
可选值：
-
0 - 所有终端
-
1 - 仅包含威胁被拦截的受管理计算机
blockedEmails布尔型
该成员仅在以下情况设置：
filterType取值为1时生效可选值：
-
真 -
假
blockedWebsites布尔型
该成员仅在以下情况设置：
filterType取值为1时生效可选值：
-
真 -
假
-
-
设备控制活动
该对象必须包含以下成员：
名称
类型
描述
reportingInterval整数型
该成员为必填项
该数值取决于报告
发生频率。更多信息请参阅 报告间隔与重复频率之间的关系 . -
端点保护状态
该对象必须包含以下成员：
名称
类型
描述
filterType整数
该成员为必填项。
可选值：
-
0 - 所有端点
-
1 - 仅包含通过下文所述成员筛选的端点。
antivirusOn布尔值
仅当
filterType取值为1时需设置此成员。可选值：
-
True，表示在报告中包含启用反恶意软件保护的端点。 -
False，表示在报告中排除启用反恶意软件保护的端点。
antivirusOff布尔值
仅当
filterType取值为1时需设置此成员。可选值：
-
True，以在报告中包含反恶意软件保护已禁用的端点。 -
False，以从报告中排除反恶意软件保护已禁用的端点。
updatedboolean
仅当
filterType的值为1时，才应设置此成员。可能的值：
-
True，以在报告中包含已更新的端点。 -
False，以从报告中排除已更新的端点。
disabledboolean
仅当
filterType的值为1时，才应设置此成员。可能的值：
-
True，以在报告中包含更新已禁用的端点。 -
False，以从报告中排除更新已禁用的端点。
outdatedboolean
仅当
filterType的值为1时，才应设置此成员。可能的值：
-
True，以在报告中包含过时的端点。 -
假，以从报告中排除过时的端点。
在线布尔型
仅当
filterType值为1时，才应设置该成员。可能的值：
-
真，以在报告中包含在线端点。 -
假，以从报告中排除在线端点。
离线布尔型
仅当
filterType值为1时，才应设置该成员。可能的值：
-
真，以在报告中包含离线端点。 -
假，以从报告中排除离线端点。
-
-
防火墙活动
该对象必须包含以下成员：
名称
类型
描述
reportingInterval整数
该成员为必填项。
此值取决于报告
发生情况。更多信息请参阅 报告间隔与复发之间的关系 .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 - 仅状态未知的端点
-
-
按需扫描
该对象必须包含以下成员：
名称
类型
描述
报告间隔整数
该成员为必填项。
此值取决于报告
出现频率。更多信息请参阅 报告间隔与重复频率的关系 . -
安全审计
该对象必须包含以下成员：
名称
类型
描述
报告间隔整数
该成员为必填项。
此值取决于报告
出现频率。更多信息请参阅 报告间隔与重复频率的关系 . -
检测到的十大恶意软件
该对象必须包含以下成员：
名称
类型
描述
报告间隔整数
该成员为必填项。
此值取决于报告
出现频率。更多信息请参阅 报告间隔与重复频率的关系 . -
感染最严重的10个终端
该对象必须包含以下成员：
名称
类型
描述
报告间隔整数
该成员为必填项。
此值取决于报告
出现频率。更多信息请参阅 报告间隔与重复频率的关系 . -
更新状态
该对象必须包含以下成员：
名称
类型
描述
已更新布尔值
可能取值：
-
True，以在报告中包含已更新的端点。 -
False，以在报告中排除已更新的端点。
disabledboolean
可选值：
-
True，以在报告中包含更新被禁用的端点。 -
False，以在报告中排除更新被禁用的端点。
outdatedboolean
可选值：
-
True，以在报告中包含过时的端点。 -
False，以在报告中排除过时的端点。
pendingRestartboolean
可选值：
-
True，以在报告中包含需要重启的端点。 -
False，以在报告中排除需要重启的端点。
-
-
虚拟机网络保护状态
该对象必须包含以下成员：
名称
类型
描述
filterType整数
该成员为必填项。
可选值：
-
0 - 所有端点
-
1 - 仅受保护端点
-
-
电子邮件安全使用情况
该对象必须包含以下成员：
名称
类型
描述
reportingInterval整数
该成员为必填项。
此值取决于报告
occurrence。更多信息请参阅 报告间隔与重复发生的关系 . -
HyperDetect活动
该对象必须包含以下成员：
名称
类型
描述
reportingInterval整数
该成员为必填项。
此值取决于报告
occurrence。更多信息请参阅 报告间隔与重复发生之间的关系 . -
网络补丁状态
该对象必须包含以下成员：
名称
类型
描述
filterType整数
可能取值：
-
0 - 所有可用补丁
-
1 - 仅补丁清单中可见的补丁
-
-
沙箱分析器提交失败记录
该对象必须包含以下成员：
名称
类型
描述
reportingInterval整数
该成员为必填项。
该值取决于报告
发生情况。更多信息请参阅 报告间隔与重复发生之间的关系 . -
网络事件
该对象必须包含以下成员：
名称
类型
描述
报告间隔整数
该成员为必填项。
此值取决于报告
发生情况。更多信息请参阅 报告间隔与重复发生之间的关系 . -
完整性监测活动
该对象必须包含以下成员：
名称
类型
描述
报告间隔整数
该成员为必填项。
此值取决于报告
发生情况。更多信息请参阅 报告间隔与重复发生之间的关系 . -
完整性监测配置变更
该对象必须包含以下成员：
名称
类型
描述
报告间隔整数
该成员为必填项。
此值取决于报告
发生次数。更多信息请参阅 报告间隔与重复周期的关系 .
重要提示
以下报告不应设置该对象：
-
终端模块状态
-
许可证状态
-
升级状态
-
策略合规性
-
安全服务器 状态
-
终端加密状态
-
MDR服务状态
报告间隔与重复周期的关系
|
发生次数 |
报告间隔 |
|---|---|
|
2 - 每小时报告 |
可选值：
|
|
3 - 每日报告 |
可选值：
|
|
4 - 每周报告 |
可选值：
对于
|
|
5 - 月度报告 |
可选值：
对于
|
|
6 - 年度报告 |
可选值：
|
返回值
该方法返回一个字符串：所创建报告的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"
}