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

验证仪表盘面板

校验设置面板适合画布范围重叠。

调试可用性

在线调试

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

请求参数

请求体字段

  • panelsList必填

    面板列表。

    示例： (nested array)

    • panelIdString

      面板ID。

      示例： panel-cpu-001

    • xInteger

      面板横向坐标。

      示例： 20

    • yInteger

      面板纵向坐标。

      示例： 20

    • wInteger

      面板宽度。

      示例： 12

    • hInteger

      面板高度。

      示例： 8

  • maxPanelOverrideInteger必填

    面板数量上限覆盖值。

    示例： 20

响应状态

200 OK

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

  • validBoolean

    是否有效。

    示例： true

  • errorCodeString

    LDAP错误分类编码。

    示例： INVALID_CONFIG

  • conflictsList

    冲突列表。

    示例： (nested array)

    • panelAIdString

      面板A的ID。

      示例： panel-cpu-001

    • panelBIdString

      面板B的ID。

      示例： panel-mem-002

    • overlapXInteger

      X坐标重叠区域。

      示例： 6

    • overlapYInteger

      Y坐标重叠区域。

      示例： 20

    • overlapWInteger

      宽度重叠区域。

      示例： 2

    • overlapHInteger

      高度重叠区域。

      示例： 4

  • boundErrorsList

    绑定错误。

    示例： (nested array)

    • panelIdString

      面板ID。

      示例： panel-cpu-001

    • fieldString

      字段名称。

      示例： w

    • valueInteger

      字段值。

      示例： 25

    • messageString

      错误返回消息。

      示例： panel width 25 exceeds canvas width 24

  • panelCountInteger

    面板数量。

    示例： 6

  • maxPanelsInteger

    最大允许面板仪表盘。

    示例： 20

  • suggestionString

    建议信息。

    示例： consider increasing the threshold

请求地址

POST/api/v1/monitoring/dashboards/validate

/api/v1/monitoring/dashboards/validate

操作 ID

ValidateDashboardPanels

永久链接

请求示例

curl -X POST '{host}/api/v1/monitoring/dashboards/validate' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"panels":"(nested array)","maxPanelOverride":20}'

响应示例

200
{
  "valid": true,
  "errorCode": "INVALID_CONFIG",
  "conflicts": [
    {}
  ],
  "boundErrors": [
    {}
  ],
  "panelCount": 6,
  "maxPanels": 20,
  "suggestion": "consider increasing the threshold"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史