跳转到主要内容
ZStack
告警与响应相关接口/告警路由与策略

接收平台告警

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

POST/api/v1/alerting/receive

操作 ID

ReceivePlatformAlerts

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • source
    String必填

    来源信息。

    示例： zstack

  • token
    String必填

    令牌。

    示例： hmac-token-abc123

  • alerts
    List必填

    告警列表。

    示例： (nested array)

    • status
      String

      状态信息。

      示例： firing

    • fingerprint
      String

      指纹标识。

      示例： abc123def456

    • generatorURL
      String

      生成源地址。

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

    • labels
      LinkedHashMap

      标签列表。

      示例： (nested object)

    • annotations
      LinkedHashMap

      注解信息。

      示例： (nested object)

    • startsAt
      String

      开始时间。

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

    • endsAt
      String

      结束时间。

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

  • commonLabels
    LinkedHashMap必填

    公共标签。

    示例： (nested object)

响应状态

200 OK
200 OK

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

  • received
    Integer

    数量告警已接收负载。

    示例： 5

  • created
    Integer

    数量新告警已创建。

    示例： 3

  • updated
    Integer

    数量已存在告警已更新。

    示例： 1

  • skipped
    Integer

    数量重复告警已跳过。

    示例： 1

  • injected
    Integer

    数量告警已注入管道。

    示例： 4

  • fallback
    Boolean

    回退处理已使用。

    示例： false

  • fallbackReason
    String

    原因回退适用。

    示例： primary channel unavailable

变更历史

查看全部变更历史

  • 变更时间

    新增请求体字段 generatorURL已删除请求体字段 generatorUrl
    查看 API