调用 URL/REST API

调用 URL/REST API 可让您将 Site24x7 的事件数据与多个第三方应用程序对接，实现 IT 工作流的自动化。它是一种"用户自定义 HTTP 回调操作"，也常被称为 Webhook，是一种基于事件的输出机制。您可以在 Site24x7 中定义特定事件，例如监视器的状态变更或属性变更。一旦 Site24x7 中发生事件，系统将把事件数据推送至您指定的 Hook URL。您可以在监视器级别或属性级别映射调用 URL/REST API 操作，还可以将与中断监视器相关的事件参数和自定义参数随 POST URL 的正文一并传递。

用例：

调用 URL/REST API 的一个典型应用场景是，将 Site24x7 的事件、告警或消息集成到第三方事件管理工具或团队协作软件中进行统一管理。这将大大提升团队协作效率，提高工作人员的生产力。

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

设置调用 URL/REST API

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

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

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

- 超时：输入时间（秒），确定 Site24x7 服务器在判定网站无响应之前的等待时长。请输入一个有别于网站通常响应时间的值。超时时间默认设置为 15 秒，您可以自定义为 1~90 秒之间的值。
- 通过邮件发送自动化结果：将自动化结果通过邮件发送给通知配置文件中配置的用户告警组。该邮件将包含自动化名称、自动化类型、事件原因、目标主机等参数。
  注意
  如果在一次数据采集中执行了多个自动化，将发送一封汇总邮件。
- 点击保存。