异步搜索 API

    最后更新于：

    该API支持在后台运行搜索请求，您可实时监控请求进度，并在结果生成时即时查看。

    执行同步搜索查询的步骤如下：

    • 您可以使用一组必需的元数据和异步参数发起搜索请求。
    • 服务器将返回请求ID并在后台线程执行搜索。
    • 您可通过Jobs接口查询请求状态。
    • 任务完成后，可通过jobs/results接口获取结果。
    • 搜索结果将在EventLog Analyzer中保留24小时，之后将由清理线程删除。

    请求网址

    POSThttp://hostname:8095/RestAPI/v1/search/async

    请求头

    Header name 值 必填 描述
    授权 持有人 {{AuthToken}} 是 API设置页面生成的AuthToken。

    例如：
    Bearer
    mdrkoda0odmtmznloc00ndziltg0mgutmwzkztljmjvmzwmx

    请求参数

    请求需以 JSON 格式发送在请求主体中，并包含以下键值参数：

    参数名称 默认值 必填 类型 描述
    查询 * 否 字符串 列表起始值
    主机 全部 否 JSONArray 要搜索的主机列表
    组 全部 否 JSONArray 要搜索的设备组列表
    从 当前时间 - 24 小时 否 长整型 搜索开始时间（Unix毫秒制）
    至 当前时间 否 长 搜索结束时间（以Unix毫秒为单位）
    注意
    1. 当光标通过时，其他参数无需填写。
    2. 查询字符串中的引号（即 " "）需进行转义。例如：若在事件日志分析器的搜索页面查询为 REMOTE_INTERFACE = "switch 1"，则Rest Api的查询参数应写为 "REMOTE_INTERFACE = \"switch 1\""

    响应

    响应将是一个 JSON 对象，包含以下键值对

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

    使用cURL的示例用法

    请求示例

    复制到剪贴板

    curl --location --request POST 'http://localhost:8095/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_id": "AX6qKwX7hJby8kAkaqDG", "status": 200 }

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

    Asynchronous Search API