資料夾/儀表板搜尋API - Amazon Managed Grafana
搜尋資料夾和儀表板

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

資料夾/儀表板搜尋API

使用 FolderDashboard-Search API 在 Amazon 受管的 Grafana 工作區中搜尋資料夾和儀表板。

注意

若要將 Grafana API 與您的 Amazon 受管理工作區搭配使用，您必須擁有有效的 Grafana API 權杖。您可以在 API 要求的Authorization欄位中包含此項目。如需如何建立權杖以驗證 API 呼叫的相關資訊，請參閱使用令牌進行身。

搜尋資料夾和儀表板

GET /api/search/

查詢參數：

  • 查詢-搜索查詢

  • 標籤 — 要搜尋的標籤清單。這些是 Grafana 標籤，而不 AWS 是標籤。

  • type — 要搜尋的類型，dash-folder或dash-db。

  • 儀表板 DIDs — 要搜尋的儀表板 ID 清單。

  • 資料夾 ID — 要在儀表板中搜尋的儀表板 ID 清單。

  • 已標示星號 — 指定僅傳回加星號的控制面板的旗標。

  • 限制 — 限制傳回結果的數量 (最大值為 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
  }
]