跳转到主要内容
POST
查看仪表盘详情

限制说明

使用说明

  • 读取对账户内所有成员开放,因此任意目录中的仪表盘都可见,不受该目录所属团队限制。不存在或属于其他账户的仪表盘 ID 返回 DashboardNotFound(HTTP 404)。
  • 位于回收站的仪表盘返回 DashboardDeleted(HTTP 410),不返回定义;可用 POST /monit/dashboard/trash/list 找到它,再用 POST /monit/dashboard/restore 恢复。
  • 下次更新、移动或删除时,把返回的 revision 作为 expected_revision 传入。

授权

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}$

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

已存储的仪表盘:包含标识、版本号、所在目录与完整定义。每次写入成功 revision 都会递增,下一次变更需把它作为 expected_revision 回传。