Skip to main content
POST
查询告警规则列表

限制说明

使用说明

  • folder_id 设为 0 可列出当前用户有权查看的所有文件夹下的规则。
  • triggered 字段表示该规则当前是否有活跃告警。

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

按文件夹查询规则的过滤参数。

folder_id
integer<uint64>

文件夹 ID,必须是已存在的文件夹;传 0 会返回 folder_not_found 错误。

include_descendants
boolean

是否同时包含所有子孙文件夹中的规则。为 true 时返回的每项仅包含 idfolder_idname 三个字段;配合 query / limit 用于规则选择器场景。

query
string

规则名模糊过滤,仅在 include_descendantstrue 时生效。

limit
integer
默认值:50

返回规则数量上限,仅在 include_descendantstrue 时生效。默认 50,最大 100。

必填范围: x <= 100

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object[]
必填

告警规则基础信息列表。