跳转到主要内容
POST
查询监控目录列表

限制说明

使用说明

  • 响应是指定范围内文件夹的扁平列表而非树:请用 parent_id 与 parent_path 重建层级,并在客户端自行搜索。账户下没有可见文件夹时返回 []。
  • 由 scope 决定范围。不传 scope 时,账户所有者、管理员和拥有全部团队查看范围的角色按 all,其他成员按 mine。mine 为自己所在团队的文件夹与自己创建的文件夹、其下全部子文件夹,以及到达它们所需经过的祖先文件夹;all 为账户下的全部文件夹。该范围只用于过滤视图,不再限制可读取的对象。
  • writable 只表示文件夹授权(团队成员、文件夹创建者、账户所有者或管理员);app_key 的功能权限另行校验,做编辑入口时需两者一起判断。
  • 仪表盘与告警规则共用这棵文件夹树,因此同一批 ID 会作为仪表盘载荷和告警规则中的 folder_id 出现。

授权

app_key
string
query
必填

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

请求体

application/json

文件夹类列表接口的可选读取范围。请求体为空等同于不传 scope。

scope
enum<string>

响应覆盖哪些文件夹。mine 为调用方所在团队的文件夹与调用方创建的文件夹及其子孙文件夹;all 为账户下的全部文件夹。不传时,账户所有者、管理员和拥有全部团队查看范围的角色按 all,其他成员按 mine。其他值返回 InvalidParameter。

可用选项:
mine,
all

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object[]

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