事件日志分析器 REST API
最后更新于:
在本页面
EventLog Analyzer提供REST应用程序接口(API),实现其日志管理功能与其他应用程序的无缝集成。通过该API,您可在其他应用程序中访问EventLog Analyzer,轻松执行必要的日志监控与分析。以下是可用API及其使用步骤:
注意:令牌具有管理员权限,可无限制访问所有设备数据。
| API | 功能 |
|---|---|
| 获取日志源 | 获取EventLog Analyzer中可用的日志源列表。 |
| 获取日志字段 | 获取已处理日志中解析出的日志字段列表。 |
| 获取日志类型 | 获取事件日志分析器中所有可用日志类型的列表。 |
| 同步搜索 | 在事件日志分析器中执行搜索。 所有搜索结果在返回给用户之前均由服务器获取。 |
| 异步搜索 | 搜索在后台执行,用户将获得请求ID。可通过Jobs端点监控请求状态。 |
| 作业端点 | 用于获取或删除所有正在运行、失败或已完成的异步搜索、告警任务的状态。 |
| 任务结果接口 | 用于获取已完成异步搜索任务的搜索结果和告警结果。 |
| 获取告警配置文件 | 获取事件日志分析器中所有可用告警配置文件的列表。 |
| 同步告警 | 获取事件日志分析器中的告警数据。 所有告警结果在返回给用户之前均由服务器获取。 |
| 异步告警 | 告警数据检索在后台执行,用户将获得请求ID。可通过Jobs端点监控请求状态。 |
| 获取产品详情 | 获取EventLog Analyzer产品详情。 |
| 禁用设备 | 在EventLog Analyzer中禁用日志源。 |
| 通过工单同步事件状态/严重性 | 根据创建的工单更新事件的状态/严重性。 |
| 使用工单导出事件 | 从已创建的工单导出事件。 |
| 禁用工单通知 | 禁用工单工具连接的告警配置文件通知。 |
| 执行工作流 | 在事件日志分析器中执行预定义的工作流。 |
生成认证令牌步骤
若需从您的应用程序或服务访问事件日志分析器,您需要获取该平台的授权令牌。请按以下步骤生成:
- 以管理员身份登录事件日志分析器Web控制台。
- 前往设置 > 管理员设置 > API 设置> 点击创建新认证令牌。
- 在生成授权令牌选项卡中,选择 API 作用域,并为授权令牌设置适当的过期时间。
- 范围定义了可使用生成的认证令牌访问的API。您可选择一个或多个API纳入范围。
- 点击创建生成令牌。
- 您的认证令牌将被生成。请确保复制显示的令牌以集成到外部应用程序中,因为该令牌无法再次检索,仅可重新生成。