跳转到主要内容
POST
获取仪表盘大纲

限制说明

使用说明

  • 可用于渲染导航,或在调用 POST /monit/dashboard/panel/run 前定位面板 ID,而无需下载查询。
  • target_id 为 tab ID 时返回整个 tab;为 section ID 时返回该 tab,但只含该 section 且不含顶层面板;为面板 ID 时只返回该面板及其所在 tab/section。ID 不存在时以 TargetNotFound(HTTP 404)失败。
  • 面板条目只含可视化 kind 与数据源类型,不含查询。数据源变量的 selection 固定为 single 且不含 all。
  • 读取对账户内所有成员开放,因此任意目录中的仪表盘都可见,不受该目录所属团队限制;读取对账户内所有成员开放,不受目录所属团队限制;位于回收站的仪表盘返回 DashboardDeleted(HTTP 410)。

授权

app_key
string
query
必填

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

请求体

application/json

请求大纲,可收窄到某个 tab、section 或 panel。

dashboard_id
string
必填

仪表盘的 canonical UUIDv7。

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
target_id
string

可选的 tab/section/panel ID。设置后响应只保留包含它的分支;ID 不存在时返回 TargetNotFound。

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

仪表盘的结构大纲——只含标题、面包屑与可视化类型,不含查询和定义。传入 target_id 可把大纲收窄到某个 tab、section 或 panel。