主页 » API文档 » API文档

EventLog Analyzer API文档


本节简要介绍EventLog Analyzer API客户端对象的诸多属性。 请阅读 这些安装 EventLog Analyzer API的说明。以下描述的对象及其属性可操作。 这里.

 

请求对象

请求对象用于设置搜索所需的各种参数。以下是设置EventLog Analyzer API对象请求的方法。

 

请求对象参数

参数反馈
必选参数
时长 开始时间

此参数用于指定搜索特定条件日志的起始时间(搜索开始时间窗口)。 格式  "YYYY-mm-dd hh:mm"

时长 结束时间

此参数用于指定搜索特定条件日志的结束时间(搜索结束时间窗口)。 格式 "YYYY-mm-dd hh:mm".

可选参数
字符 查询

指示输入搜索查询 

整体 要求点击数 表示每个响应中返回的记录数。
字符 字段排序

根据指定的字段对搜索结果进行排序。未指定此参数将返回未排序的结果。参考 这里 关于如何进行搜索结果排序

字符 需要区分的

在指定的字段中返回不同的记录。 这里 获取不同搜索记录的方法。

导出搜索结果的参数。
boolean CSV需求

CSV文件导出搜索结果。 设置参数值参考这里。

字符 CSV路径 此参数用于指定要保存CSV文件的文件系统的路径。
面分布参数
字符 字段面 此参数反馈顶部/底部 'n' 搜索字段
boolean topFacet 将此参数设置为true顶部返回 'n' 结果, 反之  设置这个参数 false 返回底部 'n' 结果。
整体 facetCount 指定在分面搜索中返回的记录数。
显示页面搜索的参数。
页面细节 页面信息

不能手动设置此参数。它提供基于响应对象细节的页面信息。

boolean 翻页搜索

将此参数设置为true,可以实现向前翻页。而将此参数设置为关于如何执行翻页,false则提供向后翻页。请参考 这里 如何执行翻页。

 

 
响应对象

每个搜索结果都会返回一个响应对象。以下是响应对象的方法。

 

响应对象参数 参数反馈
列表<map<<string,string>> result 特定搜索请求的结果
long 总数 特定搜索请求的记录总数
列表<string> searchableFields 所有可以搜索的字段
列表<string> distinctFields 指定字段的不同字段值(如果设置)
list<string> fileList 如果搜索结果导出为CSV文件,则此参数将返回导出文件的位置。
页面细节 页面信息 进行页面搜索所需的信息
map<string,string> 面字段值 包含顶部/底部方面及其相应的数量
 
Copyright © 2022, ZOHO Corp。版权所有。
ManageEngine