API de pesquisa de pastas/painéis - Amazon Managed Grafana
Pastas e painéis de pesquisa

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

API de pesquisa de pastas/painéis

Use a API FolderDashboard -Search para pesquisar pastas e painéis em um espaço de trabalho Amazon Managed Grafana.

nota

Para usar uma API Grafana com seu espaço de trabalho Amazon Managed Grafana, você deve ter uma chave de API Grafana válida. Você inclui essa chave noAuthorization campo da solicitação da API. Para obter informações sobre como criar uma chave de API do Grafana, consulteUsando APIs HTTP do Grafana.

Pastas e painéis de pesquisa

GET /api/search/

Parâmetros de consulta:

  • consulta — Consulta de pesquisa

  • tag — Lista de tags a serem pesquisadas. Essas são tags Grafana, nãoAWS tags.

  • tipo — O tipo a ser pesquisado, sejadash-folder oudash-db.

  • DashboardIDs — Lista de IDs de painel a serem pesquisados.

  • FolderIDs — Lista de IDs de painel para pesquisar nos painéis.

  • estrelado — Sinalize para especificar que somente painéis favoritos devem ser retornados.

  • limite — Limita o número de resultados retornados (o máximo é 5000).

  • página — Use esse parâmetro para acessar acessos além do limite. A numeração começa em 1. Olimit parâmetro atua como tamanho da página.

Exemplo de solicitação para recuperar pastas e painéis da pasta geral

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

Exemplo de resposta para recuperar pastas e painéis da pasta geral

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

Exemplo de solicitação para pesquisar painéis com estrelas

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

Exemplo de resposta para pesquisar painéis com estrelas

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