跳转到主要内容
告警与响应相关接口/告警通道与集成
POSTAlerting起始版本 1.0同步需要认证

接收AlertmanagerWebhook

接收告警通知Alertmanager Webhook回调认证X Webhook密钥请求头静态密钥转发RPC元数据。

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

请求参数

路径参数

  • receiverString必填

    名称Alertmanager配置。

请求体字段

  • versionString必填

    版本号。

    示例: 4

  • groupKeyString必填

    分组键。

    示例: {}:{alertname=HighCPU}

  • truncatedAlertsInteger必填

    数量告警已截断负载。

    示例: 20

  • statusString必填

    状态信息。

    示例: firing

  • externalUrlString必填

    Alertmanager实例。

    示例: http://alertmanager:9093

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • receivedInteger

    数量告警已接收负载。

    示例: 5

  • createdInteger

    数量新告警已创建。

    示例: 3

  • updatedInteger

    数量已存在告警已更新。

    示例: 1

  • skippedInteger

    数量重复告警已跳过。

    示例: 1

  • injectedInteger

    数量告警已注入管道。

    示例: 4

  • fallbackBoolean

    回退处理已使用。

    示例: false

  • fallbackReasonString

    原因回退适用。

    示例: primary channel unavailable

请求地址

POST/api/v1/alerting/webhook/{receiver}

/api/v1/alerting/webhook/{receiver}

操作 ID

ReceiveAlertmanagerWebhook

永久链接

请求示例

curl -X POST '{host}/api/v1/alerting/webhook/{receiver}' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"version":"4","groupKey":"{}:{alertname=HighCPU}","truncatedAlerts":20,"status":"firing","externalUrl":"http://alertmanager:9093","groupLabels":"(nested object)","commonLabels":"(nested object)","commonAnnotations":"(nested object)","alerts":"(nested array)"}'

响应示例

200
{
  "received": 5,
  "created": 3,
  "updated": 1,
  "skipped": 1,
  "injected": 4,
  "fallback": false,
  "fallbackReason": "primary channel unavailable"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史