跳转到主要内容
POST
创建仪表盘

限制说明

使用说明

  • dashboard_id 由调用方生成,必须是规范 UUIDv7。复用已存在的 ID 会返回 HTTP 409 DashboardIDConflict。
  • 定义中读取的每个应用必须存在于本账户且调用方可读,否则返回 InvalidParameter 或 AccessDenied。
  • 定义校验失败时返回 HTTP 400,并带最多 20 条 violations,每条包含 path、rule、message,其中第一条同时作为错误 message。
  • 请求体按严格模式解码,未知字段会被拒绝并以 InvalidParameter 报错,而不是被忽略。
  • 请求体超过 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

创建请求。仪表盘 ID 由调用方提供,因此用同一 ID 重试会被判为冲突,而不会建出重复仪表盘。

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
definition
object
必填

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

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

仪表盘的存储形态,包含当前定义与版本号。