跳转到主要内容
POST
预览草稿面板

限制说明

使用说明

  • 用于在用户仍在编辑面板时检查它:草稿面板及其变量被内联执行,不会写入任何内容,也不会产生版本。
  • context 把草稿关联到已存仪表盘(existing 并带 dashboard_id)或尚无仪表盘的目录(new 并带 folder_id)。调用方需要能访问该仪表盘所在目录或该目录。
  • 草稿 panel 与 variables 按与已存定义相同的规则校验(网格、各可视化类型的查询数量、变量引用),且不得超过 1 MiB;违规时以 HTTP 400 失败,超出大小限制时为 HTTP 413。文本面板不能预览。
  • 响应结构与面板运行一致,只是不含 dashboard_id 和 revision。即使所有查询都失败,也返回 HTTP 200,请查看 run_state 以及各 ref 的 state、error。
  • max_data_points 默认 100,取值 2~5000。同时最多运行 6 个查询。响应超过 8 MiB 时以 EntityTooLarge(HTTP 413)拒绝。整个调用有 35 秒的总时限,超时返回 RuntimeTimeout(HTTP 504)。

授权

app_key
string
query
必填

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

请求体

application/json

内联执行一个草稿面板,不会产生仪表盘新版本。草稿 panel 与 variables 合计不得超过 1 MiB,请求体不得超过 2 MiB。

context
object
必填

未保存的草稿面板/变量集所属的上下文。existing 指向已存仪表盘,new 指向尚无仪表盘的目录——两者互斥。

panel
object
必填

单个可视化面板。除 text 外所有类型都必须填写 datasource_ref,text 面板不允许填写。同一容器内的面板不得重叠;24 列网格在保存时校验。

variables
object[]
必填

该面板可引用的草稿变量,最多 20 个。必填;面板查询只能使用此处列出的变量。

Maximum array length: 20

仪表盘变量。按 kind 选择对应分支。

time
object
必填

绝对求值窗口。两个边界都是 Unix 毫秒时间戳,from_ms 必须小于 to_ms,且都不得超过 JavaScript 安全整数上限。

selections
object

按变量名索引的选择,最多 20 项。未给出的变量回退到其草稿中的默认值。

max_data_points
integer | null

range 查询每条序列的目标最大点数,服务端据此推算查询步长。取值 2~5000;省略或传 null 时默认 100。

必填范围: 2 <= x <= 5000

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

草稿面板执行结果。与已存面板运行结构相同,只是不含 dashboard_id 和 revision。即使所有查询都失败也返回 HTTP 200;响应超过 8 MiB 时以 EntityTooLarge(HTTP 413)拒绝。