跳转到主要内容
POST
列出自动化规则

限制说明

使用说明

  • 可见范围:调用者自己的个人规则,加上调用者所属团队的团队规则。账户所有者和管理员同样只能看到自己所属团队的规则,看不到他人的个人规则。
  • scope=personal 只返回调用者的个人规则;scope=team 只返回调用者所属团队的规则。team_ids 只会进一步收窄结果,不会扩大访问范围。
  • 结果按 updated_at 倒序排列。规则运行过时,列表项会带上 last_run(最近一次运行)。
  • 列表项的 can_edit 表示调用者能否管理(获取、更新、删除、运行)该规则。

授权

app_key
string
query
必填

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

请求体

application/json

列出调用者可见的自动化规则:自己的个人规则,加上所属团队的团队规则。账户所有者和管理员同样受此限制。

p
integer
默认值:1

页码,从 1 开始。

limit
integer
默认值:20

每页数量。小于 1 时回退为 20,大于 200 时按 200 处理。

必填范围: x <= 200
scope
enum<string>

作用域过滤:all(默认)自己的个人规则加所属团队的规则;personal 仅自己的个人规则;team 仅所属团队的规则。

可用选项:
all,
personal,
team
team_ids
integer<int64>[]

过滤到这些团队 ID;该字段只会收窄结果,不会扩大访问范围。

include_person
boolean | null

旧版开关。仅在 scope 为空时生效:false 等同于 scope=team;其他情况忽略。

enabled
boolean | null

按启用状态过滤:true 仅返回已启用,false 仅返回已停用;省略或传 null 不过滤。

keyword
string

返回名称包含该文本的规则。最多 64 个字符。

Maximum string length: 64

响应

成功

所有 Flashduty 公开 API 共用的标准响应结构。成功时 data 为接口专属载荷且不含 error;失败时 error 存在而 data 缺失。request_id 始终存在,并会同步写入 Flashcat-Request-Id 响应头。

request_id
string
必填

本次请求的唯一 ID,与 Flashcat-Request-Id 响应头一致。反馈问题时请携带该 ID。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

error
object

响应结构中的错误 payload,仅在非 2xx 响应时出现。

data
object

接口返回的数据,格式见各接口的 200 响应。没有返回数据的接口会返回 {} 或完全不带 data。