Skip to main content
POST
更新仪表盘

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

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 文档形式存储的完整仪表盘内容。未知字段、重复字段、NaN/Inf、超范围数字与尾随值都会被拒绝;序列化后不得超过 1 MiB。

message
string

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

Maximum string length: 1024

响应

Success

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

更新或移动的结果。changed 为 false 表示本次写入是空操作——规范化后的序列化定义与已存内容逐字节相同,此时 resource 仍描述该未变化的仪表盘。