API de búsqueda de carpetas/paneles

Usa la API FolderDashboard -Search para buscar carpetas y paneles en un espacio de trabajo de Grafana gestionado por Amazon.

nota

Para usar una API de Grafana con tu espacio de trabajo de Grafana gestionado por Amazon, debes tener un token de API de Grafana válido. Lo incluyes en el Authorization campo de la solicitud de API. Para obtener información sobre cómo crear un token para autenticar tus llamadas a la API, consultaAutenticarse con fichas.

Busque carpetas y paneles

GET /api/search/

Parámetros de consulta:

• consulta: consulta de búsqueda

• etiqueta: lista de etiquetas que se van a buscar. Son etiquetas de Grafana, no AWS etiquetas.

• tipo: el tipo que se va a buscar, uno dash-folder u dash-db otro.

• DashboardIDs: lista de los ID del panel de control que se deben buscar.

• FolderIDs: lista de los identificadores de los paneles que se deben buscar en los paneles.

• destacado: marca para especificar que solo se deben mostrar los cuadros de mando destacados con estrellas.

• límite: limita el número de resultados devueltos (el máximo es 5000).

• página: utilice este parámetro para acceder a las visitas que superen el límite. La numeración comienza en 1. El limit parámetro actúa como tamaño de página.

Ejemplo de solicitud para recuperar carpetas y cuadros de mando de la carpeta general

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

Ejemplo de respuesta para recuperar carpetas y paneles de la carpeta general

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

Ejemplo de solicitud para buscar cuadros de mando destacados

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

Ejemplo de respuesta para buscar cuadros de mando destacados

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