跳转到主要内容
POST
查询仪表盘列表

限制说明

使用说明

  • 只返回直接存放在 folder_id 中的仪表盘,不包含其子目录中的仪表盘。跨目录查找请用 POST /monit/dashboard/search。
  • folder_id 必须是该账户下已存在的目录;读取对账户内所有成员开放,不受该目录所属团队限制,因此只有不存在的目录会以 FolderNotFound(HTTP 404)失败。回收站中的仪表盘不会被列出。
  • query 按空白拆分为多个词;标题或描述中包含每一个词(子串匹配)的仪表盘才会命中。
  • 排序键为 title 与 updated_at,最多两个且不可重复;默认按 updated_at 倒序,相同值再按 dashboard_id 排序。

授权

app_key
string
query
必填

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

请求体

application/json

列出某个目录下的仪表盘。与搜索不同,folder_id 必填。

folder_id
integer<uint64>
必填

要列出其直接包含的仪表盘的目录;不包含子目录。

必填范围: x >= 1
query
string

可选的搜索词,以空白分隔,最多 128 个 Unicode 字符。标题或描述中包含每一个词的仪表盘才会命中。

Maximum string length: 128
sort
object[]

排序键;默认按 updated_at 倒序。

Maximum array length: 2
p
integer

页码,从 1 开始,默认 1。

必填范围: x >= 1
limit
integer

每页条数,1~100,默认 20。

必填范围: 1 <= x <= 100

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

一页仪表盘及其匹配总数。