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

查询仪表盘列表

租户可选分类搜索过滤。

调试可用性

在线调试

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

查询参数

请求参数

查询参数

  • tenantIdString

    租户ID。

  • categoryString

    类型分类。

  • searchString

    搜索关键字。

  • pageInteger

    页码。默认值为 `1`。

    示例： 0

  • sizeInteger

    返回记录数。

    示例： 0

响应状态

200 OK

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

  • itemsList

    条目列表。

    示例： (nested array)

    • idString

      资源ID。

      示例： dash-001-abc

    • tenantIdString

      租户ID。

      示例： tenant-001-xyz

    • titleString

      标题。

      示例： VM Performance Overview

    • categoryString

      类型分类。

      示例： compute

    • layoutList

      布局信息。

      示例： (nested array)

      • panelIdString

        面板ID。

        示例： panel-cpu-001

      • xInteger

        面板横向坐标。

        示例： 20

      • yInteger

        面板纵向坐标。

        示例： 20

      • wInteger

        面板宽度。

        示例： 12

      • hInteger

        面板高度。

        示例： 8

    • createdByString

      创建该记录的用户UUID。

      示例： user-001-abc

    • createdAtString

      创建时间。

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

    • updatedAtString

      更新时间。

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

    • deletedAtString

      已删除时间。

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

    • versionInteger

      版本号。

      示例： 3

  • totalInteger

    返回结果总数。

    示例： 8

  • limitInteger

    最大返回条目数。

    示例： 20

  • offsetInteger

    查询起始偏移量。

    示例： 20

请求地址

GET/api/v1/monitoring/dashboards

/api/v1/monitoring/dashboards

操作 ID

ListDashboards

永久链接

请求示例

curl -X GET '{host}/api/v1/monitoring/dashboards' -H 'Authorization: Bearer {token}'

响应示例

200
{
  "items": [
    {}
  ],
  "total": 8,
  "limit": 20,
  "offset": 20
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史