跳转到主要内容
POST
预览草稿变量

限制说明

使用说明

  • 解析尚未存入仪表盘的草稿变量列表,便于编辑器在保存前测试变量。不落库,因此响应中没有 dashboard_id 或 revision。
  • 草稿属于已存仪表盘时,context.kind 为 existing 并带 dashboard_id;仪表盘尚不存在时为 new 并带 folder_id;混用另一种类型的字段会校验失败(HTTP 400)。调用方需要能访问该仪表盘所在目录或该目录(否则返回 403/404)。
  • 草稿 variables 按与已存定义相同的规则校验(名称、依赖、选项上限、最多 20 个变量、1 MiB);违规时以 HTTP 400 失败,超出大小限制时为 HTTP 413。
  • 解析行为与「解析仪表盘变量」一致:失败的变量带 error 且不出现在 selections 中,空的 values 选择视为未解析。
  • 整个调用有 35 秒的总时限,超时返回 RuntimeTimeout(HTTP 504)。

授权

app_key
string
query
必填

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

请求体

application/json

解析一组尚未存入任何仪表盘的草稿变量。

context
object
必填

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

variables
object[]
必填

草稿变量,最多 20 个。按与已存定义相同的规则校验(名称、依赖、选项上限),且不得超过 1 MiB。

Maximum array length: 20

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

time
object
必填

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

selections
object

按变量名索引的选择,最多 20 项。未给出的变量回退到其草稿默认值;出现不在 variables 中的变量名时,调用以 HTTP 400 失败。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

已解析的草稿变量。因为没有落库,所以不返回 dashboard_id。