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

获取告警内置规则模板列表

列表内置告警规则模板创建新规则。

调试可用性

在线调试

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

请求参数

此接口无需请求参数。

响应状态

200 OK

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

  • itemsList

    条目列表。

    示例： (nested array)

    • idString

      资源ID。

      示例： btmpl-001

    • nameString

      资源名称。

      示例： VM CPU Alert

    • descriptionString

      资源的详细描述。

      示例： Alert when VM CPU exceeds threshold

    • categoryString

      类型分类。

      示例： infrastructure

    • resourceTypeString

      资源类型。

      示例： vm

    • metricNameString

      监控项名称。

      示例： cpu_usage_percent

    • operatorString

      比较运算符。

      示例： >

    • thresholdLong

      阈值。

      示例： 90

    • durationInteger

      持续时间。

      示例： 300

    • severityString

      告警级别。

      示例： critical

    • impactScopeString

      影响范围。

      示例： cluster

  • totalInteger

    返回结果总数。

    示例： 15

  • limitInteger

    最大返回条目数。

    示例： 20

  • offsetInteger

    查询起始偏移量。

    示例： 20

请求地址

GET/api/v1/alerting/rules/builtin-templates

/api/v1/alerting/rules/builtin-templates

操作 ID

GetAlertBuiltinRuleTemplates

永久链接

请求示例

curl -X GET '{host}/api/v1/alerting/rules/builtin-templates' -H 'Authorization: Bearer {token}'

响应示例

200
{
  "items": [
    {}
  ],
  "total": 15,
  "limit": 20,
  "offset": 20
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史