API 用于手动触发通知

在线编辑

端点

在线编辑
POST /api/events/settings/alertingChannels/notify/{id}

用例

在线编辑
  • 在您尝试解决某个问题（手动或使用自动化）后，需要通知相关利益相关者。
  • 此 API 允许用户在事件或故障中手动触发警报通道。

请求有效内容

在线编辑

请参考以下有效载荷示例：

{
    "eventId": "eventIdToTriggerAlertFor",
    "customPayloadFields": [
        {
            "type": "staticString",
            "key": "hello",
            "value": "world"
        },
        {
            "type": "staticString",
            "key": "alert",
            "value": "payload"
        }
    ]
}

许可权

在线编辑

您需要相关 canInvokeAlertChannel 权限才能使用 API。

有效载荷详情

在线编辑
  • eventId （字符串，必填）：与警报关联的事件ID。
  • customPayloadFields （可选数组）：警报有效负载中包含的键值对列表。
    • 数组中的每个对象包含：
    • type：指定有效载荷字段的类型（例如， staticString ）。
    • key：关键名称。
    • value：对应值。

预期回应

在线编辑
  • 成功（200 OK ）：警报通道成功触发。
  • 错误（400 错误请求 ）：无效请求有效负载。
  • 错误（404 未找到 ）：警报通道ID不存在。
  • 错误（500内部服务器错误 ）：意外服务器错误。

其他说明

在线编辑
  • customPayloadFields 部分为选填项。
  • 此 API 是对现有用于测试 PUT /api/events/settings/alertingChannels/{id} 警报通道的 API 的补充。
  • 在发出请求前，请确保警报通道ID有效。