跳转到主要内容
API Explorer|API Explorer
告警与响应相关接口/告警路由与策略
POSTAlerting起始版本 1.0同步需要认证

接收平台告警

接收纳管平台（ZStack 或 ZStone）发送的告警通知，并通过查询参数中的令牌完成 HMAC 认证。

调试可用性

在线调试

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

请求参数

请求体字段

  • sourceString必填

    来源信息。

    示例： zstack

  • tokenString必填

    令牌。

    示例： hmac-token-abc123

  • alertsList必填

    告警列表。

    示例： (nested array)

    • statusString

      状态信息。

      示例： firing

    • fingerprintString

      指纹标识。

      示例： abc123def456

    • generatorUrlString

      生成源地址。

      示例： http://prometheus:9090/graph?g0.expr=up

    • labelsLinkedHashMap

      标签列表。

      示例： (nested object)

    • annotationsLinkedHashMap

      注解信息。

      示例： (nested object)

    • startsAtString

      开始时间。

      示例： 2024-01-15T09:30:00Z

    • endsAtString

      结束时间。

      示例： 2024-01-15T10:00:00Z

  • commonLabelsLinkedHashMap必填

    公共标签。

    示例： (nested object)

响应状态

200 OK

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

  • receivedInteger

    数量告警已接收负载。

    示例： 5

  • createdInteger

    数量新告警已创建。

    示例： 3

  • updatedInteger

    数量已存在告警已更新。

    示例： 1

  • skippedInteger

    数量重复告警已跳过。

    示例： 1

  • injectedInteger

    数量告警已注入管道。

    示例： 4

  • fallbackBoolean

    回退处理已使用。

    示例： false

  • fallbackReasonString

    原因回退适用。

    示例： primary channel unavailable

请求地址

POST/api/v1/alerting/receive

/api/v1/alerting/receive

操作 ID

ReceivePlatformAlerts

永久链接

请求示例

curl -X POST '{host}/api/v1/alerting/receive' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"source":"zstack","token":"hmac-token-abc123","alerts":"(nested array)","commonLabels":"(nested object)"}'

响应示例

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

变更历史

此 API 暂无变更历史记录。

查看全部变更历史