文件夹/控制面板搜索 API - Amazon Managed Grafana
搜索文件夹和控制面板

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

文件夹/控制面板搜索 API

使用 FolderDashboard-Search API 在 Amazon Managed Grafana 工作区中搜索文件夹和控制面板。

注意

要对 Amazon Managed Grafana 工作区使用 Grafana API，您必须拥有有效的 Grafana API 令牌。您可以将其包含在 API 请求的 Authorization 字段中。有关如何创建令牌对 API 调用进行身份验证的信息，请参阅 使用令牌进行身份验证。

搜索文件夹和控制面板

GET /api/search/

查询参数：

  • query：搜索查询

  • tag：要搜索的标签列表。这些是 Grafana 标签，而不是 AWS 标签。

  • type：要搜索的类型，可以是 dash-folder 或 dash-db。

  • dashboardIds：要搜索的控制面板 Id 列表。

  • folderIds：要在控制面板中搜索的控制面板 Id 列表。

  • starred：用来指定仅返回已加星标的控制面板的标记。

  • limit：限制返回结果的数量（最大值为 5000）。

  • page：使用此参数访问超出限制的命中次数。计数从 1 开始。limit 参数充当页面大小。

检索常规文件夹的文件夹和控制面板的请求示例

GET /api/search?folderIds=0&query=&starred=false HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

检索常规文件夹的文件夹和控制面板的响应示例

HTTP/1.1 200
Content-Type: application/json

[
  {
    "id": 163,
    "uid": "000000163",
    "title": "Folder",
    "url": "/dashboards/f/000000163/folder",
    "type": "dash-folder",
    "tags": [],
    "isStarred": false,
    "uri":"db/folder" // deprecated in Grafana v5.0
  },
  {
    "id":1,
    "uid": "cIBgcSjkk",
    "title":"Production Overview",
    "url": "/d/cIBgcSjkk/production-overview",
    "type":"dash-db",
    "tags":[prod],
    "isStarred":true,
    "uri":"db/production-overview" // deprecated in Grafana v5.0
  }
]

搜索已加星标的控制面板的请求示例

GET /api/search?query=Production%20Overview&starred=true&tag=prod HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

搜索已加星标的控制面板的响应示例

HTTP/1.1 200
Content-Type: application/json

[HTTP/1.1 200
Content-Type: application/json

[
  {
    "id":1,
    "uid": "cIBgcSjkk",
    "title":"Production Overview",
    "url": "/d/cIBgcSjkk/production-overview",
    "type":"dash-db",
    "tags":[prod],
    "isStarred":true,
    "folderId": 2,
    "folderUid": "000000163",
    "folderTitle": "Folder",
    "folderUrl": "/dashboards/f/000000163/folder",
    "uri":"db/production-overview" // deprecated in Grafana v5.0
  }
]