REST API 主动(应用程序)
- Last Updated: October 16, 2024
- 4 minute read
- WhatsUp Gold
- Version 2024
REST API 主动监控器组件允许您在特定设备上运行监控器,并通过评估监控器是联机还是脱机来获取有关设备、服务器或应用程序状态的信息。
要将 REST API 主动监控器作为组件添加到现有应用程序,请执行以下操作:
- 选择 设置 > 应用程序监控 > 应用程序和配置文件设置 。
- 按照 使用应用程序配置文件 中所述添加应用程序配置文件。
- 按照 组件、关键组件组和独立应用程序 中所述添加组件。
- 在“应用程序配置文件编辑”对话框中,选择“组件”选项卡,然后单击“添加”图标以添加新组件。
- 对于组件名称,选择 REST API > REST API 主动 。
- 在组件编辑器中,配置以下字段:
- 名称 。输入组件的唯一名称。此名称显示在应用程序配置文件编辑器的“性能组件”页面中。
- 描述 。输入组件的其他信息。
- 关键 。选择它是否是关键组件。
- 设备取代 。选择是否要使设备取代此组件。
- 轮询间隔时间 。选择检查组件的间隔时间。
- 连接超时 。选择超时之前的请求长度。
-
REST API
。为组件添加 REST API 端点的 URL。注: 在 REST API URL 中支持系统 (%System)、设备 (%Device) 和应用程序 (%Application) 的引用变量(也称为百分比变量)。如需详细信息,请参阅 百分比变量 。但是,如果测试,表达式的值将为 False 。建议在参数化表达式并将其附加到设备之前,确保 REST API 返回有效响应。
-
编辑自定义标头
。最多输入十个访问 REST API 端点所需的自定义标头。提供了默认的 Accept 标头,并将其指定为
应用程序/json
。注: 为了监控 Progress Application Server for OpenEdge OEManager REST API 端点,必须将 Accept 标头设置为 应用程序/vnd.progress+json 或 */* 。
- 方法 。为 REST API 端点选择受支持的 HTTP 方法。当前仅支持 GET 方法。
- 忽略证书错误 。启用此复选框即可强制 WhatsUp Gold 忽略证书错误。
- 使用匿名访问 。如果 REST API 端点不需要身份验证,请选中此框。
-
JSONPATH
。输入要监控的 JSON 对象的路径,或使用 JSONPath Builder 确保您具有要监控的对象的正确路径。 注: 有关 JSONPath 和 JSONPath Builder 的更多信息,请参阅 JSONPath 查询和 JSONPath Builder 。
- JSONPath Builder 。输入有效的 REST API URL 端点后,可以使用 JSONPath Builder 查看 JSON 响应的结构,并选择要监控的 JSON 值。
- 脱机条件 。如果返回了列出的任何 HTTP 响应代码,监控器将报告为已脱机。您可以控制哪些响应代码指示监控器已脱机,还可以提供 JSONPath 查询以及指示监控器是否已脱机的条件。监控器可以使用脱机条件、JSONPath 查询或同时使用二者来返回脱机响应。
- JSONPATH 查询 。设计逻辑测试以评估 REST API 端点返回的条件:
- 选择“添加”图标以使用 JSONPath 查询输入条件测试。默认情况下,“未设定比较”文本会内联显示。
- 在 JSONPath 查询条目内双击,然后选择放大镜徽标。如果未选中“使用匿名访问”,则会提示您输入 REST API 凭据。验证 REST API 凭据 之后,将打开 JSONPath Builder 窗口。
- 选择要监控的端点。
- 构建一个逻辑测试,该测试表示监控 REST API 端点的脱机条件。支持的值类型为布尔值、数字、字符串和其他。“其他”数据类型检查值是否为 null。支持空字符串。
- 单击 保存 。
- 选择 测试 以运行 REST API。
- 单击 确定 退出组件编辑器。
要将此组件添加到设备上的现有应用程序配置文件,请执行以下操作:
- 转到“监控的应用程序”,然后选择“添加”图标。
- 添加您创建的应用程序配置文件,以及要附加该应用程序配置文件的设备。
- 根据需要配置其他字段。
- 单击 保存 。
组件测试在设备上运行。