跳转到主要内容
告警与响应相关接口/告警规则

查询告警规则已过滤列表

列表告警规则过滤分类严重级别状态标签。

GET/api/v1/alerting/rules

操作 ID

ListAlertRulesFiltered

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • category
    String

    类型分类。

  • severity
    String

    告警级别。

  • state
    String

    当前状态。

  • source
    String

    来源信息。

  • labelSelectors
    String

    标签选择器。

响应状态

200 OK
200 OK

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

  • items
    List

    条目列表。

    示例: (nested array)

    • uuid
      String

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

      示例: rule-abc123

    • name
      String

      资源名称。

      示例: High CPU Usage

    • description
      String

      资源的详细描述。

      示例: Alert when CPU exceeds 90%

    • resourceType
      String

      资源类型。

      示例: vm

    • metricName
      String

      监控项名称。

      示例: cpu_usage_percent

    • operator
      String

      比较运算符。

      示例: >

    • threshold
      Long

      阈值。

      示例: 90

    • duration
      Integer

      持续时间。

      示例: 300

    • severity
      String

      告警级别。

      示例: critical

    • state
      String

      当前状态。

      示例: enabled

    • notifyUrl
      String

      通知回调地址。

      示例: https://hooks.example.com/notify

    • platformUuid
      String

      平台UUID。

      示例: plat-001-abc

    • type
      String

      类型。

      示例: metric

    • logQuery
      String

      日志查询语句。

      示例: level=error

    • logWindow
      Integer

      日志查询时间窗口。

      示例: 600

    • category
      String

      类型分类。

      示例: infrastructure

    • labelSelectors
      List

      标签选择器。

      示例: (nested array)

      • key
        String

        键。

        示例: value

      • operator
        String

        比较运算符。

        示例: value

      • values
        List

        值。

        示例: item1,item2

    • source
      String

      来源信息。

      示例: builtin

    • impactScope
      String

      影响范围。

      示例: cluster

    • createDate
      String

      创建时间。

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

    • lastOpDate
      String

      最近一次操作时间。

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

    • productType
      String

      产品类型。

      示例: value

    • resourceSubType
      String

      资源。

      示例: value

    • sourceSystem
      String

      资源。

      示例: value

    • sourceAlarmUuid
      String

      资源。

      示例: value

    • sourceAlarmName
      String

      资源。

      示例: value

    • sourceNamespace
      String

      资源。

      示例: value

    • sourceMetricName
      String

      资源。

      示例: value

    • sourceLabels
      String

      资源。

      示例: value

    • filterRules
      String

      资源。

      示例: value

    • conditionType
      String

      资源。

      示例: value

    • thresholdUnit
      String

      资源。

      示例: value

    • rawPeriod
      Integer

      资源。

      示例: 10

    • rawEmergencyLevel
      String

      资源。

      示例: value

    • ruleStatus
      String

      资源。

      示例: value

    • prometheusMetricStatus
      String

      资源。

      示例: value

    • defaultConfigSnapshot
      String

      资源。

      示例: value

    • sourceRawPayload
      String

      资源。

      示例: value

    • ruleId
      String

      规则ID。

      示例: value

    • resourceTypeDisplayName
      String

      资源类型显示名称。

      示例: 组件实例

    • metricDisplayName
      String

      指标显示名称。

      示例: 组件重启频率

  • total
    Integer

    返回结果总数。

    示例: 25

  • limit
    Integer

    最大返回条目数。

    示例: 20

  • offset
    Integer

    查询起始偏移量。

    示例: 20

  • 变更时间

    新增请求参数 Accept-Language新增响应字段 metricDisplayName, resourceTypeDisplayName, ruleId
    查看 API
  • 变更时间

    新增响应字段 key, values
    查看 API
  • 变更时间

    新增请求参数 productType, prometheusMetricStatus, ruleStatus...新增响应字段 conditionType, defaultConfigSnapshot, filterRules...
    查看 API