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

限制说明

使用说明

  • 定义整体替换,没有局部更新。
  • expected_revision 必须等于当前版本号,否则返回 HTTP 409 DashboardRevisionConflict;请用 POST /rum/dashboard/get 重新读取后重试。
  • 定义未变化时返回 changed: false,版本号不变。
  • 每次变更都会存一个版本(最多保留 20 个),并带上可选的 message。
  • 不存在的仪表盘返回 HTTP 404 DashboardNotFound;位于回收站的返回 HTTP 410 DashboardDeleted。
  • 请求体超过 2 MiB、定义超过 1 MiB 或超出数量上限时返回 HTTP 413 EntityTooLarge;schema_version 不是 dashboard.v1 时返回 HTTP 422 UnsupportedSchemaVersion。
  • 与创建相同,更新时会校验定义中读取的应用。

授权

app_key
string
query
必填

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

请求体

application/json

更新请求。expected_revision 使写入带条件:仪表盘已被他人改动时返回 DashboardRevisionConflict。

dashboard_id
string
必填

仪表盘 ID,规范 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>
必填

定义所遵循的接口 schema,必须为 dashboard.v1。

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

调用方最后读取到的版本号,至少为 1。

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

仪表盘主体:标题、默认时间范围、变量与页签。一个仪表盘最多 10 个页签、100 个面板、300 条查询。每个页签最多 30 个面板、100 条查询,固定面板与分区面板合计。

message
string

随该版本保存的可选变更说明,最多 1024 字符。

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,此时仍返回 resource。