REST API(主动)
- Last Updated: October 16, 2024
- 3 minute read
- WhatsUp Gold
- Version 2024
REST API 主动监控器允许您监控任何支持匿名和基本身份验证的 REST API。此外,它还允许您使用 JSONPath 查询来验证 JSON 响应。
要配置 REST API 主动监控器,请执行以下操作:
- 名称 。输入监控工具的唯一名称。此名称会显示在主动监控器库中。
- 描述 。输入监控工具的其他信息。这段说明会在主动监控器库中显示在监控器名称的旁边。
- 用于重新扫描 。此选项指示 WhatsUp Gold,当搜索检测到任何需要此主动监控器的新条件时,它应该尝试应用此监控器。
- 超时 。输入 WhatsUp Gold 等待 REST API 响应的时间应该要多久,一旦超出就终止连接并返回超时错误信息。最小允许值是 1 秒,最大允许值是 120 秒。
-
REST API
-
编辑自定义标头
。最多输入十个访问 REST API 端点所需的自定义标头。提供了默认的 Accept 标头,并将其指定为
应用程序/json
。注: 为了监控 Progress Application Server for OpenEdge OEManager REST API 端点,必须将 Accept 标头设置为 应用程序/vnd.progress+json 或 */* 。
-
REST API URL
。要监控的 REST API 端点的 URL。注: 在 REST API URL 中支持系统 (%System)、设备 (%Device) 和应用程序 (%Application) 的引用变量(也称为百分比变量)。如需详细信息,请参阅 百分比变量 。
- 方法 。为 REST API 端点选择一个受支持的 HTTP 方法。当前仅支持 GET 方法。
- 忽略证书错误 。启用此复选框即可强制 WhatsUp Gold 忽略证书错误。
- 使用匿名访问 。如果 REST API 端点不需要身份验证,请选中此框。
-
编辑自定义标头
。最多输入十个访问 REST API 端点所需的自定义标头。提供了默认的 Accept 标头,并将其指定为
应用程序/json
。
- 脱机条件 。如果返回了列出的任何 HTTP 响应代码,监控器将报告为已脱机。您可以控制哪些响应代码指示监控器已脱机,还可以提供 JSONPath 查询以及指示监控器是否已脱机的条件。监控器可以使用脱机条件、JSONPath 查询或同时使用二者来返回脱机响应。
-
JSONPATH 查询
。设计逻辑测试以评估 REST API 端点返回的条件:
- 选择“添加”图标以使用 JSONPath 查询输入条件测试。默认情况下,“未设定比较”文本会内联显示。
- 在 JSONPath 查询条目内双击,然后选择放大镜徽标。如果未选中“使用匿名访问”,则会提示您输入 REST API 凭据。验证 REST API 凭据 之后,将打开 JSONPath Builder 窗口。
- 选择要监控的端点。
- 构建一个逻辑测试,该测试表示监控 REST API 端点的脱机条件。支持的值类型为布尔值、数字、字符串和其他。“其他”数据类型检查值是否为 null。支持空字符串。
- 单击 保存 。
注:
有关 JSONPath 和 JSONPath Builder 的更多信息,请参阅
JSONPath 查询和 JSONPath Builder
。