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

查询告警规则范围字段列表

列出当前产品/资源/指标上下文下允许使用的告警范围字段。

GET/api/v1/alerting/rules/scope-fields

操作 ID

ListAlertRuleScopeFields

起始版本

1.2.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • productType
    String

    产品类型。

  • resourceType
    String

    资源类型。

  • metricName
    String

    监控项名称。

  • platformUuid
    String

    平台UUID。

响应状态

200 OK
200 OK

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

  • items
    List

    条目列表。

    示例： (nested array)

    • key
      String

      键。

      示例： zone

    • displayName
      String

      显示名称。用于界面展示。

      示例： Zone

    • source
      String

      来源信息。

      示例： platform

    • valueType
      String

      已使用过滤表达式。

      示例： label_text

    • operators
      List

      受支持过滤运算符。

      示例： item1,item2

    • valueMode
      String

      值模式。

      示例： enum

    • requiredContext
      List

      上下文密钥必需查询。

      示例： item1,item2

    • description
      String

      资源的详细描述。

      示例： Filter alert rules by resource zone

  • total
    Integer

    返回结果总数。

    示例： 8

  • limit
    Integer

    最大返回条目数。

    示例： 8

  • offset
    Integer

    查询起始偏移量。

    示例： 20