跳转到主要内容
API Explorer|API Explorer
监控与采集相关接口/Grafana 仪表盘
POSTGrafana起始版本 1.0同步需要认证

检查仪表盘版本

检查客户端S预期版本匹配当前仪表盘版本阻止过期写入。

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

请求参数

路径参数

  • dashboardIdString必填

    仪表盘ID。

请求体字段

  • expectedVersionInteger必填

    期望的版本号。

    示例： 5

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • matchBoolean

    匹配。

    示例： true

  • currentVersionInteger

    当前服务器端版本仪表盘。

    示例： 5

  • requestVersionInteger

    客户端提供预期版本。

    示例： 5

  • diffSummaryString

    对比汇总。

    示例： 2 panels added, 1 removed

  • errorCodeString

    LDAP错误分类编码。

    示例： INVALID_CONFIG

请求地址

POST/api/v1/monitoring/dashboards/{dashboardId}/version-check

/api/v1/monitoring/dashboards/{dashboardId}/version-check

操作 ID

CheckDashboardVersion

永久链接

请求示例

curl -X POST '{host}/api/v1/monitoring/dashboards/{dashboardId}/version-check' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"expectedVersion":5}'

响应示例

200
{
  "match": true,
  "currentVersion": 5,
  "requestVersion": 5,
  "diffSummary": "2 panels added, 1 removed",
  "errorCode": "INVALID_CONFIG"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史