フォルダ/ダッシュボード検索 API - Amazon Managed Grafana
フォルダとダッシュボードの検索

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

フォルダ/ダッシュボード検索 API

FolderDashboard-Search API を使用して、Amazon Managed Grafana ワークスペース内のフォルダとダッシュボードを検索します。

注記

Amazon Managed Grafana ワークスペースで Grafana API を使用するには、有効な Grafana API トークンが必要です。これは API リクエストの Authorizationフィールドに含めます。API コールを認証するトークンを作成する方法については、「」を参照してくださいトークンによる認証。

フォルダとダッシュボードの検索

GET /api/search/

クエリパラメータ：

  • クエリ — クエリの検索

  • 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
  }
]