# 任务 API

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

#### A) 获取任务状态：

#### 请求 URL

GET http://localhost:8400/RestAPI/v1/search/async/jobs

#### 请求头

头名称 | 值 | 必需的 | 描述
Authorization | Bearer {{AuthToken}} | 是 |

#### 请求参数

参数名 | 必填 | 类型 | 描述
request_id | 否 | String | 如果提供了request_id，只会获取该请求ID的状态

#### 响应

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

参数名称 | 描述
total | 下一组结果的游标
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) 删除作业：

该功能允许您删除作业及其命中结果

DELETE http://localhost:8400/RestAPI/v1/search/async/jobs

#### 请求头

Header 名称 | 值 | 必须 | 描述
Authorization | Bearer {{AuthToken}} | 是 |

#### 请求参数

参数名称 | 是否必填 | Type | 描述
request_id | 否 | String | 如果提供，则只会获取该request_id的状态

#### 响应

响应将是一个JSON对象，其中包含一个message字段

参数名 | 描述
message | 删除请求的结果

#### 使用cURL进行示例

#### i) 删除特定请求的状态信息和hits

#### 示例请求

复制到剪贴板

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

#### 示例响应：

复制到剪贴板

{ { "message": "deleted hits for for request_id [AX6qJeaDhJby8kAkaqDE]" } }

#### 使用 Postman (第三方工具) 的示例

#### i). 获取所有作业的状态

#### ii) 获取特定请求id的状态

#### iii) 删除特定请求id的结果

## 本页内容

- 生成 AuthToken 的步骤
- 使用元数据执行端点搜索
- 同步搜索
- 异步搜索

Copyright © 2023，ZOHO Corp。版权所有。
ManageEngine