跳转到主要内容
ZStack
监控与采集相关接口/Grafana 仪表盘

验证新增仪表盘面板

校验新面板新增已存在仪表盘布局冲突。

POST/api/v1/monitoring/dashboards/validate-add

操作 ID

ValidateAddDashboardPanels

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • existing
    List必填

    现有面板列表。

    示例： (nested array)

    • panelId
      String

      面板ID。

      示例： panel-cpu-001

    • x
      Integer

      面板横向坐标。

      示例： 20

    • y
      Integer

      面板纵向坐标。

      示例： 20

    • w
      Integer

      面板宽度。

      示例： 12

    • h
      Integer

      面板高度。

      示例： 8

  • newPanels
    List必填

    新增面板列表。

    示例： (nested array)

    • panelId
      String

      面板ID。

      示例： panel-cpu-001

    • x
      Integer

      面板横向坐标。

      示例： 20

    • y
      Integer

      面板纵向坐标。

      示例： 20

    • w
      Integer

      面板宽度。

      示例： 12

    • h
      Integer

      面板高度。

      示例： 8

  • maxPanelOverride
    Integer必填

    面板数量上限覆盖值。

    示例： 20

响应状态

200 OK
200 OK

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

  • valid
    Boolean

    是否有效。

    示例： true

  • errorCode
    String

    LDAP错误分类编码。

    示例： INVALID_CONFIG

  • conflicts
    List

    冲突列表。

    示例： (nested array)

    • panelAId
      String

      面板A的ID。

      示例： panel-cpu-001

    • panelBId
      String

      面板B的ID。

      示例： panel-mem-002

    • overlapX
      Integer

      X坐标重叠区域。

      示例： 6

    • overlapY
      Integer

      Y坐标重叠区域。

      示例： 20

    • overlapW
      Integer

      宽度重叠区域。

      示例： 2

    • overlapH
      Integer

      高度重叠区域。

      示例： 4

  • boundErrors
    List

    绑定错误。

    示例： (nested array)

    • panelId
      String

      面板ID。

      示例： panel-cpu-001

    • field
      String

      字段名称。

      示例： w

    • value
      Integer

      字段值。

      示例： 25

    • message
      String

      错误返回消息。

      示例： panel width 25 exceeds canvas width 24

  • panelCount
    Integer

    面板数量。

    示例： 6

  • maxPanels
    Integer

    最大允许面板仪表盘。

    示例： 20

  • suggestion
    String

    建议信息。

    示例： consider increasing the threshold