Such-API für Ordner/Dashboards

Fokusmodus

Such-API für Ordner/Dashboards - Amazon Managed Grafana

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Verwenden Sie die FolderDashboard -Search-API, um Ordner und Dashboards in einem Amazon Managed Grafana-Arbeitsbereich zu durchsuchen.

Anmerkung

Um eine Grafana-API mit Ihrem Amazon Managed Grafana-Workspace verwenden zu können, benötigen Sie ein gültiges Grafana-API-Token. Sie fügen dies in das Authorization Feld in der API-Anfrage ein. Informationen zum Erstellen eines Tokens zur Authentifizierung Ihrer API-Aufrufe finden Sie unterAuthentifizieren Sie sich mit Tokens.

Ordner und Dashboards durchsuchen


GET /api/search/

Parameter abfragen:

Abfrage — Suchabfrage
Tag — Liste der Tags, nach denen gesucht werden soll. Dies sind Grafana-Tags, keine AWS Tags.
type — Der Typ, nach dem gesucht werden soll, entweder dash-folder oderdash-db.
dashboardIds — Liste der Dashboard-IDs, nach denen gesucht werden soll.
folderIds — Liste der Dashboard-IDs, nach denen in Dashboards gesucht werden soll.
starred — Markierung, um anzugeben, dass nur mit einem Stern markierte Dashboards zurückgegeben werden sollen.
limit — Beschränkt die Anzahl der zurückgegebenen Ergebnisse (maximal 5000).
page — Verwenden Sie diesen Parameter, um auf Treffer zuzugreifen, die das Limit überschreiten. Die Nummerierung beginnt bei 1. Der limit Parameter dient als Seitengröße.

Beispielanfrage zum Abrufen von Ordnern und Dashboards des allgemeinen Ordners


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

Beispielantwort für das Abrufen von Ordnern und Dashboards des allgemeinen Ordners


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

Beispielanfrage für die Suche nach Dashboards, die mit einem Stern markiert wurden


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

Beispielantwort für die Suche nach mit einem Stern markierten Dashboards


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