跳转到主要内容
POST
解析仪表盘变量

限制说明

使用说明

  • 解析已存仪表盘当前版本的变量。variables 是调用方当前的选择;未给出的变量回退到存储的默认值(custom、query 变量用 default;datasource 变量用 default_datasource_id,若它已不在候选项中,则取按名称排序的第一个候选项)。
  • 无法解析的变量不会导致调用失败:其条目会带上 error,并且不出现在 selections 中。常见原因:既无选择也无默认值、所选值不在候选项中、依赖项未解析、数据源不可达。
  • 显式传入空的 values 表示未解析(variable_invalid),解析器不会回退到存储的默认值。
  • 变量按依赖顺序解析,依赖了失败变量的变量也会报错。variables 中出现仪表盘未定义的变量名时,调用以 HTTP 400 失败。
  • 每个变量最多返回 1000 个候选项,所有候选项合计须在 8 MiB 以内,否则以 EntityTooLarge(HTTP 413)失败。query 变量只能对 Prometheus、MySQL、Loki 数据源执行。
  • 调用方须能看到该仪表盘所在的目录,否则返回 DashboardNotFound(HTTP 404)。整个调用有 35 秒的总时限,超时返回 RuntimeTimeout(HTTP 504)。

授权

app_key
string
query
必填

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

请求体

application/json

针对一个时间范围和调用方当前的选择,解析已存仪表盘的全部变量。

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}$
time
object
必填

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

variables
object

已做出的选择,按变量名索引,最多 20 项。未给出的变量回退到其存储的默认值;出现仪表盘未定义的变量名时,调用以 HTTP 400 失败。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

已解析的变量,以及每个名称的生效选择。