调用 URL/REST API

Invoke URL/REST API 允许您通过将您的 Site24x7 事件数据与多个第三方应用程序连接来自动化您的 IT 工作流。这是一个“用户定义的 HTTP 回调操作”，通常也称为Webhook。它作为基于事件的输出机制工作。您可以在 Site24x7 中定义特定事件，例如监视器的状态或属性更改。一旦 Site24x7 发生事件或事件，它会将事件数据发布到您指定的 Hook URL。您可以在监视器级别或属性级别映射调用 URL/REST API 操作。您可以进一步传递与中断监视器关联的事件和自定义参数以及 POSTED URL 的正文。

用例：

可以通过调用 URL/REST API 实现的典型任务是管理和简化第三方事件管理工具或团队协作软件中的 Site24x7 事件、告警或消息。它将极大地改善团队协作并提高员工的生产力。

• 与 PagerDuty、VictorOps 等第三方软件集成，以在其统一的仪表板中处理 Site24x7 告警。
• 使用 Slack 或 HipChat 等应用程序构建强大的工作流程，您可以在其中将 Site24x7 事件中断作为消息发布到 Slack 频道或 HipChat 房间。 

设置调用 URL/REST API

1. 登录到 Site24x7。
2. 导航到 管理>   IT 自动化模板 > 添加自动化模板。
3. 选择自动化类型作为Invoke URL/REST API。
4. 提及以下详细信息以设置调用 URL/REST API：
   • 显示名称：指定名称以标识指定的操作。
     例如：服务器重启
   • URL：指定将触发您的意图操作的 URL。
   • HTTP 方法：指定用于连接站点的 CRUD 方法。Site24x7 支持 GET、POST、PUT、PATCH 和 DELETE 方法。
     
     POST、PUT、PATCH 和 DELETE HTTP 提交方法支持 JSON 格式的请求发送。
   • HTTP 请求标头：有时您可能想要自定义默认的 HTTP 请求标头信息。在这种情况下，可以在此处添加附加的标头名称和标头值。
   • 用户代理：设置自定义用户代理（Web 浏览器）以发送您的请求和 HTTP 标头。您可以从可用的用户代理中进行选择。
   
   
   • 身份验证方法：指定单选按钮并相应地更新凭证。
     • 基本/NTLM 凭证： 配置基于基本/NTLM 的授权。Windows NTLM 是在 Windows 操作系统上运行的系统上使用的身份验证协议。
       凭证： 为需要基于基本/NTLM身份验证的 URL 指定您的用户名和密码 。
     • OAuth： 如果您正在监视由 OAuth 框架保护的资源，请选择 OAuth 单选按钮。
       提供者名称： 从您的预配置列表中选择 OAuth 提供者名称，或通过单击+按钮创建新的 OAuth 配置文件 。
       
       了解如何配置 OAuth 提供者。
   • 发送事件参数： 选择此选项以启用与您的监视器中断相关的事件参数与您的 POST URL 的正文一起传递。 了解有关事件参数的更多信息。
     
     仅当实际状态更改或与监视器关联的属性更改时，事件参数才会与 POST URL 一起传递。执行测试 IT 自动化时不会发送任何事件参数
     
     
   • 发送自定义参数：为 POST 和 GET HTTP 方法编写特定代码以参数名称=值对格式传递参数 。您可以以 JSON 格式发布请求。在 HTTP 请求期间传递自定义参数时，您可以  在名称或值字段中指定预定义的全局参数。全局参数被您定义的常量或 HTTP 响应中的实际动态值替换。应使用以下任一语法传递自定义参数： 

以 JSON 格式指定时的自定义参数语法：

未以 JSON 格式指定时的自定义参数语法：

1. • 超时：输入以秒为单位的时间，以确定 Site24x7 服务器在将网站视为无响应之前应等待多长时间。以秒为单位输入一个时间，该时间不是您网站的通常响应时间。默认情况下，超时设置为15 秒。您可以在1-90 秒之间定义超时。
   • 通过电子邮件发送自动化结果：通过电子邮件将自动化结果分享到您在通知配置文件中配置的用户告警组 。此电子邮件将包含参数，包括自动化名称、自动化类型、事件原因、目标主机等。
     如果您在一个数据收集中执行了多个自动化，则会发送一封合并的电子邮件。
   • 单击保存。

测试自动化

设置调用 URL/REST API 后，转到IT 自动化摘要页面（管理>  IT 自动化模板）并使用该 图标进行测试运行。了解更多。

单击 IT 自动化日志以查看按日期执行的自动化列表。

在调用 URL/REST API 期间传递事件和自定义参数： 

比如说，您已经定义了一组全局参数，用作您的自定义参数名称：值对。然后，您已指定要在 POSTED URL 的正文中传递的自定义参数。

当针对您指定的监视器状态更改或属性更改执行调用 URL/REST API 操作时，还会在 URL 正文中传递以下自定义参数。您可以在下面的屏幕截图底部找到全局参数值已在您的 HTTP 响应中替换为常量或动态值。由于这是一个测试调用，因此没有事件参数与您定义的自定义参数一起传递。

但是在下面的示例中，HTTP 请求的 JSON 响应清楚地突出显示并列出了与您指定的所有自定义参数值一起传递的实际事件参数。

 

用事件映射自动化

要执行自动化，请将其映射到所需的事件。这可以通过两种方式完成：

• 监视器级别映射
• 属性级别映射