异步搜索API

该API允许您在后台运行搜索请求,您可以监视请求的进度,并在结果可用时查看结果。

以下是执行异步搜索查询的步骤:

  • 您可以使用一组必需的元数据和异步参数进行搜索请求。
  • 服务器将通过请求ID响应并在后台线程中执行搜索。
  • 您可以通过作业端点检查请求的状态。
  • 完成作业后,您可以使用作业/结果端点获取结果。
  • 搜索结果将在EventLog Analyzer中可用24小时,之后由清理线程删除。

请求URL

GET http://hostname:8400/RestAPI/v1/search/async

请求头

头部名称 必需 描述
授权 Bearer {{AuthToken}} 从API设置页面生成的AuthToken。

例如:
Bearer
mdrkoda0odmtmznloc00ndziltg0mgutmwzkztljmjvmzwmx

请求参数

请求需要使用JSON格式发送到请求体中,并应包含以下键/值参数

参数名称 默认值 是否必填 Type 描述
query * String 要搜索的起始值
hosts all JSONArray 要搜索的主机列表
groups all JSONArray 要搜索的设备组列表
from 当前时间-24小时 Long 搜索的起始时间,使用Unix毫秒表示
to 当前时间 Long 搜索的结束时间,使用Unix毫秒表示
注意:
  1. 传递游标时,其他参数不需要。
  2. 查询字符串中的引号(即“”)应该被转义。如果在EventLog Analyzer的搜索页面中查询为REMOTE_INTERFACE =“switch 1”,则在Rest Api中,查询参数应该被写成“REMOTE_INTERFACE = \“switch 1\””

响应

响应将是一个JSON对象,其中包含以下键值对

参数名称 描述
request_id 后台搜索的请求ID,类型=字符串

使用示例(使用 cURL)

请求示例

复制到剪贴板

curl --location --request POST 'http://localhost:8400/RestAPI/v1/search/async' \ -H "Accept: application/json" -H "Authorization: Bearer mdrkoda0odmtmznloc00ndziltg0mgutmwzkztljmjvmzwmx " --data-raw '{ "query": "EVENTID = 16384 AND USERNAME = mhtoc", "hosts": [1, 2, 601], "groups": [3], "from": 1643480792000, "to": 1643480479500 }'

响应示例:

复制到剪贴板

{ "message": "Request submitted", "request_id": "AX6qKwX7hJby8kAkaqDG", "status": 200 }

使用第三方工具 Postman 的示例用法

Asynchronous Search API
Copyright © 2023,ZOHO Corp。版权所有。