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

查询仪表盘列表

租户可选分类搜索过滤。

GET/api/v1/monitoring/dashboards

操作 ID

ListDashboards

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • tenantId
    String

    租户ID。

  • category
    String

    类型分类。

  • search
    String

    搜索关键字。

  • page
    Integer

    页码。默认值为 `1`。

    示例： 0

  • size
    Integer

    返回记录数。

    示例： 0

响应状态

200 OK
200 OK

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

  • items
    List

    条目列表。

    示例： (nested array)

    • id
      String

      资源ID。

      示例： dash-001-abc

    • tenantId
      String

      租户ID。

      示例： tenant-001-xyz

    • title
      String

      标题。

      示例： VM Performance Overview

    • category
      String

      类型分类。

      示例： compute

    • layout
      List

      布局信息。

      示例： (nested array)

      • panelId
        String

        面板ID。

        示例： panel-cpu-001

      • x
        Integer

        面板横向坐标。

        示例： 20

      • y
        Integer

        面板纵向坐标。

        示例： 20

      • w
        Integer

        面板宽度。

        示例： 12

      • h
        Integer

        面板高度。

        示例： 8

    • createdBy
      String

      创建该记录的用户UUID。

      示例： user-001-abc

    • createdAt
      String

      创建时间。

      示例： 2026-01-15T08:00:00Z

    • updatedAt
      String

      更新时间。

      示例： 2026-01-15T08:00:00Z

    • deletedAt
      String

      已删除时间。

      示例： 2026-01-15T08:00:00Z

    • version
      Integer

      版本号。

      示例： 3

  • total
    Integer

    返回结果总数。

    示例： 8

  • limit
    Integer

    最大返回条目数。

    示例： 20

  • offset
    Integer

    查询起始偏移量。

    示例： 20