跳转到主要内容
POST
查询告警规则列表

限制说明

使用说明

  • folder_id 必须是已存在的文件夹:传 0 或不存在的 ID 返回 InvalidParameter;调用者对该文件夹无管理权限(账户所有者或管理员、该文件夹或其上级文件夹的创建者,或绑定到该文件夹或其上级文件夹的团队成员)时返回 AccessDenied。不支持跨文件夹列出整个账户的规则。
  • 默认只返回直接位于该文件夹下的规则,按名称排序,并填充 active_alert_count 与 runtime_state。
  • include_descendants 为 true 时会搜索该文件夹及其所有子孙文件夹,按名称排序最多返回 limit 条;此时只填充 id、folder_id、name,其余字段为零值(labels 为 null,不返回 runtime_state)。
  • 当且仅当 active_alert_count > 0 时 triggered 为 true。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

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

folder_id
integer<uint64>

要列出的文件夹 ID,必须是调用者有管理权限的已存在文件夹;传 0 或不存在的 ID 返回 InvalidParameter。

include_descendants
boolean

是否同时搜索所有子孙文件夹。为 true 时结果按名称排序、受 limit 限制,且每项只填充 id、folder_id、name(其余字段为零值);可配合 query 用于规则选择器场景。

query
string

按规则名称子串过滤;纯数字时还会匹配该 ID 的规则。仅在 include_descendants 为 true 时生效。

limit
integer
默认值:50

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

必填范围: x <= 100

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object[]

告警规则基础信息列表。