Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
API de recherche dans les dossiers/tableaux de bord
Utilisez l'API FolderDashboard -Search pour rechercher des dossiers et des tableaux de bord dans un espace de travail Grafana géré par Amazon.
Note
Pour utiliser une API Grafana avec votre espace de travail Amazon Managed Grafana, vous devez disposer d'un jeton d'API Grafana valide. Vous l'incluez dans le Authorization
champ de la demande d'API. Pour plus d'informations sur la création d'un jeton pour authentifier vos appels d'API, consultezAuthentifiez-vous avec des jetons.
Dossiers et tableaux de bord de recherche
GET /api/search/
Paramètres de requête :
-
query — Requête de recherche
-
tag — Liste des tags à rechercher. Ce sont des tags Grafana, pas AWS des tags.
-
type — Le type à rechercher,
dash-folder
soitdash-db
. -
DashboardIds : liste des identifiants de tableau de bord à rechercher.
-
FolderIds : liste des identifiants de tableau de bord à rechercher dans les tableaux de bord.
-
étoilé — Indicateur indiquant que seuls les tableaux de bord marqués d'un astérisque doivent être renvoyés.
-
limite — Limite le nombre de résultats renvoyés (le maximum est de 5 000).
-
page — Utilisez ce paramètre pour accéder à un nombre de visites illimité. La numérotation commence à 1. Le
limit
paramètre agit comme taille de page.
Exemple de demande pour récupérer les dossiers et les tableaux de bord du dossier général
GET /api/search?folderIds=0&query=&starred=false HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Exemple de réponse pour récupérer les dossiers et les tableaux de bord du dossier général
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 } ]
Exemple de demande de recherche de tableaux de bord marqués d'un favori
GET /api/search?query=Production%20Overview&starred=true&tag=prod HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Exemple de réponse pour la recherche de tableaux de bord marqués d'un favori
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 } ]