跳转到主要内容
POST
更新仪表盘

限制说明

使用说明

  • 需要发送完整定义;未包含的内容会被删除,不会沿用已存版本。
  • expected_revision 必须等于已存版本号,否则以 DashboardRevisionConflict(HTTP 409)失败;请重新读取仪表盘后重试。
  • 成功后 revision 加 1,并记录一条带 message 的版本。规范化后的定义与 schema_version 都与已存内容相同时,changed 为 false,revision 不变,也不会记录版本。
  • 标题与描述会去除首尾空白,未填写的数值 unit 会存为 unitless,因此返回的 definition 可能与请求略有不同。
  • 位于回收站的仪表盘返回 DashboardDeleted(HTTP 410);调用方无权访问其所在目录时返回 AccessDenied。校验与大小错误与 POST /monit/dashboard/create 相同。
  • 会记录审计日志。

授权

app_key
string
query
必填

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

请求体

application/json

替换仪表盘定义。发送的是完整定义而非补丁;expected_revision 使该写入成为 compare-and-swap。

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}$
schema_version
enum<string>
必填

线上协议版本;只接受 dashboard.v1。

可用选项:
dashboard.v1
expected_revision
integer<uint64>
必填

调用方最后读到的版本号。若与已存版本不一致,写入会以 DashboardRevisionConflict 失败。

必填范围: x >= 1
definition
object
必填

以可移植 dashboard.v1 文档形式存储的完整仪表盘内容。未知字段、重复字段、尾随值以及超过 32 层的嵌套都会被拒绝,序列化后不得超过 1 MiB。上限:10 个 tab,每个 tab 10 个 section、30 个面板、100 条查询,每个仪表盘 100 个面板、300 条查询,20 个变量。

message
string

可选版本说明,最多 1024 个 Unicode 字符。随版本存储,但本接口不回显。

Maximum string length: 1024

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

更新或移动的结果。changed 为 false 表示未做任何写入——更新时规范化后的定义与 schema_version 均与已存内容相同;移动时仪表盘已在目标目录中。此时 revision 不变,resource 描述未变化的仪表盘。