Jobs API

    最后更新于：

    该API允许您获取/删除在EventLog Analyzer中运行的所有后台搜索/告警任务的状态，包括正在运行和已完成的任务。

    A) 获取任务状态：

    请求URL

    GEThttp://localhost:8095/RestAPI/v1/jobs

    请求头

    Header name 值 必填 描述
    授权 持有人 {{AuthToken}} 是

    请求参数

    参数名称 必填 类型 描述
    请求ID 否 字符串 若提供此参数，则仅获取该请求ID的状态

    响应

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

    参数名称 描述
    总数 用于获取下一组结果的游标
    requests JSON数组包含每个作业的JSONObject信息。

    每个JSONObject包含以下字段

    • running_time_in_millis= 可读运行时间，类型 = long
    • hits_done= 已完成命中数
    • status= 任务状态，取值：SUCCESS（成功）、FAILED（失败）或 RUNNING（运行中）
    • submitted_at= 任务提交时的Unix纪元时间（毫秒制）
    • started_at= 任务启动的Unix纪元时间（毫秒制）
    • running_time= 作业运行时间
    • last_synced_time= 状态刷新至数据库的最后同步时间（Unix毫秒制）
    • total_pages= 本次搜索结果的总页数
    • request_id= 作业请求ID

    B) 删除任务：

    此操作可删除任务及其匹配项

    DELETEhttp://localhost:8095/RestAPI/v1/jobs

    请求头

    Header name 值 必填 描述
    授权 持有人 {{AuthToken}} 是  

    请求参数

    参数名称 必填 类型 描述
    请求ID 否 字符串 若提供此参数，则仅获取该请求ID的状态

    响应

    响应将是一个包含消息字段的 JSON 对象

    参数名称 描述
    消息 删除请求的结果

    使用cURL的示例用法

    i) 删除特定请求ID的状态信息及访问次数

    请求示例

    复制到剪贴板

    curl --location --request DELETE 'http://localhost:8095/RestAPI/v1/jobs?request_id=AYVTeCb0wPH5eWuO5jkC' \ -H "Accept: application/json" -H "Authorization: Bearer mdrkoda0odmtmznloc00ndziltg0mgutmwzkztljmjvmzwmx "

    示例响应：

    复制到剪贴板

    { "message": "已删除请求ID [AX6qJeaDhJby8kAkaqDE] 的命中记录" }

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

    i). 获取所有任务状态

    Jobs API

    ii) 获取特定请求ID的状态

    Jobs API

    iii) 删除特定请求ID的命中记录

    Jobs API