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

创建告警静默规则

创建静默规则抑制告警通知时间窗口。

调试可用性

在线调试

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

请求参数

请求体字段

  • nameString必填

    资源名称。

    示例： Maintenance Window

  • descriptionString必填

    资源的详细描述。

    示例： Suppress alerts during scheduled maintenance

  • matcherTypeString必填

    匹配器类型。

    示例： value

  • matcherKeyString必填

    标签键匹配针对。

    示例： value

  • matcherValueString必填

    标签值模式匹配。

    示例： value

响应状态

200 OK

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

  • uuidString

    资源的UUID，唯一标识该资源。

    示例： silence-001

  • nameString

    资源名称。

    示例： Maintenance Window Q1

  • descriptionString

    资源的详细描述。

    示例： Suppress alerts during scheduled maintenance

  • matcherTypeString

    匹配器类型。

    示例： value

  • matcherKeyString

    标签键匹配针对。

    示例： value

  • matcherValueString

    标签值模式匹配。

    示例： value

  • startsAtString

    开始时间。

    示例： 2026-01-15T08:00:00Z

  • endsAtString

    结束时间。

    示例： 2026-01-15T08:00:00Z

  • createdByString

    创建该记录的用户UUID。

    示例： admin

  • createDateString

    创建时间。

    示例： 2026-01-15T08:00:00Z

  • matchersList

    匹配器。

    示例： (nested array)

    • typeString

      类型。

      示例： exact

    • keyString

      键。

      示例： severity

    • valueString

      字段值。

      示例： critical

请求地址

POST/api/v1/alerting/silence-rules

/api/v1/alerting/silence-rules

操作 ID

CreateAlertSilenceRule

永久链接

请求示例

curl -X POST '{host}/api/v1/alerting/silence-rules' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"Maintenance Window","description":"Suppress alerts during scheduled maintenance","matcherType":"value","matcherKey":"value","matcherValue":"value","startsAt":"2026-01-15T08:00:00Z","endsAt":"2026-01-15T08:00:00Z","createdBy":"admin","matchers":"(nested array)"}'

响应示例

200
{
  "uuid": "silence-001",
  "name": "Maintenance Window Q1",
  "description": "Suppress alerts during scheduled maintenance",
  "matcherType": "example",
  "matcherKey": "example",
  "matcherValue": "example",
  "startsAt": "example",
  "endsAt": "example"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史