API de pastas - Amazon Managed Grafana
Criar pastaPasta de atualizaçãoObtenha todas as pastasObter pasta por uidObter pasta por idExcluir pasta por uid

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 pastas

Use a API de pastas para trabalhar com pastas no espaço de trabalho Amazon Managed Grafana.

O identificador (id) de uma pasta é um valor numérico de incremento automático e só é exclusivo por espaço de trabalho. O identificador exclusivo (uid) de uma pasta pode ser usado para identificar de forma exclusiva uma pasta entre vários espaços de trabalho. Ela é gerada automaticamente se você não fornecer uma ao criar uma pasta. O uid permite ter URLs consistentes para acessar a pasta e ao sincronizar a pasta entre vários espaços de trabalho Amazon Managed Grafana. O uso do uid significa que alterar o título de uma pasta não interrompe nenhum link marcado para essa pasta.

O uid pode ter um tamanho máximo de 40 caracteres.

As pastas não podem ser aninhadas.

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.

A pasta Geral, com umid de 0, não faz parte da API de pastas. Você não pode usar a API de pastas para recuperar informações sobre a pasta geral.

Criar pasta

POST /api/folders

Cria uma nova pasta.

Exemplo de solicitação

POST /api/folders HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "uid": "nErXDvCkzz",
  "title": "Department ABC"
}

Esquema corporal JSON:

  • uid — Identificador exclusivo opcional. Se nulo, um novo uid é gerado.

  • title — O título da pasta.

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "uid": "nErXDvCkzz",
  "title": "Department ABC",
  "url": "/dashboards/f/nErXDvCkzz/department-abc",
  "hasAcl": false,
  "canSave": true,
  "canEdit": true,
  "canAdmin": true,
  "createdBy": "admin",
  "created": "2018-01-31T17:43:12+01:00",
  "updatedBy": "admin",
  "updated": "2018-01-31T17:43:12+01:00",
  "version": 1
}

HTTP Status Codes

  • 200 — Criado

  • 400 — Erro como JSON inválido, campos inválidos ou ausentes

  • 401 — Não autorizado

  • 403 — Acesso negado

Pasta de atualização

PUT /api/folders/:uid

Atualiza a pasta existente que corresponde ao uid.

Exemplo de solicitação

PUT /api/folders/nErXDvCkzz HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "title":"Department DEF",
  "version": 1
}

Esquema corporal JSON:

  • uid — Altera o identificador exclusivo, se fornecido.

  • title — O título da pasta.

  • versão — Forneça a versão atual para poder sobrescrever a pasta. Não é necessário seoverwrite=true.

  • substituir — Defina comotrue para substituir a pasta existente por uma versão mais recente.

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "uid": "nErXDvCkzz",
  "title": "Department DEF",
  "url": "/dashboards/f/nErXDvCkzz/department-def",
  "hasAcl": false,
  "canSave": true,
  "canEdit": true,
  "canAdmin": true,
  "createdBy": "admin",
  "created": "2018-01-31T17:43:12+01:00",
  "updatedBy": "admin",
  "updated": "2018-01-31T17:43:12+01:00",
  "version": 1
}

HTTP Status Codes

  • 200 — Criado

  • 400 — Erro como JSON inválido, campos inválidos ou ausentes

  • 401 — Não autorizado

  • 403 — Acesso negado

  • 404 — Pasta não encontrada

  • 412 — Falha na pré-condição

O código de status 412 é usado para explicar por que a pasta não pode ser atualizada.

  • A pasta foi alterada por outra pessoastatus=version-mismatch

O corpo da resposta tem as seguintes propriedades:

HTTP/1.1 412 Precondition Failed
Content-Type: application/json; charset=UTF-8
Content-Length: 97

{
  "message": "The folder has been changed by someone else",
  "status": "version-mismatch"
}

Obtenha todas as pastas

GET /api/folders

Retorna todas as pastas que você tem permissão para visualizar. Você pode controlar o número máximo de pastas retornadas usando o parâmetrolimit query. O padrão é 1000.

Exemplo de solicitação

GET /api/folders?limit=10 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

[
  {
    "id":1,
    "uid": "nErXDvCkzz",
    "title": "Department ABC"
  },
  {
    "id":2,
    "uid": "k3S1cklGk",
    "title": "Department RND"
  }
]

Obter pasta por uid

GET /api/folders/:uid

Retorna todas as pastas que correspondem ao uid fornecido.

Exemplo de solicitação

GET /api/folders/nErXDvCkzzh HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "uid": "nErXDvCkzz",
  "title": "Department ABC",
  "url": "/dashboards/f/nErXDvCkzz/department-abc",
  "hasAcl": false,
  "canSave": true,
  "canEdit": true,
  "canAdmin": true,
  "createdBy": "admin",
  "created": "2018-01-31T17:43:12+01:00",
  "updatedBy": "admin",
  "updated": "2018-01-31T17:43:12+01:00",
  "version": 1
}

HTTP Status Codes

  • 200 — Encontrado

  • 401 — Não autorizado

  • 403 — Acesso negado

  • 404 — Não encontrado

Obter pasta por id

GET /api/folders/id/:id

Retorna a pasta que corresponde ao id fornecido.

Exemplo de solicitação

GET /api/folders/id/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "uid": "nErXDvCkzz",
  "title": "Department ABC",
  "url": "/dashboards/f/nErXDvCkzz/department-abc",
  "hasAcl": false,
  "canSave": true,
  "canEdit": true,
  "canAdmin": true,
  "createdBy": "admin",
  "created": "2018-01-31T17:43:12+01:00",
  "updatedBy": "admin",
  "updated": "2018-01-31T17:43:12+01:00",
  "version": 1
}

HTTP Status Codes

  • 200 — Encontrado

  • 401 — Não autorizado

  • 403 — Acesso negado

  • 404 — Não encontrado

Excluir pasta por uid

DELETE /api/folders/:uid

Exclui a pasta correspondente ao uid e também exclui todos os painéis armazenados na pasta. Essa operação não pode ser revertida.

Exemplo de solicitação

DELETE /api/folders/nErXDvCkzz HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

{
  "message":"Folder deleted",
  "id": 2
}

HTTP Status Codes

  • 200 — Excluído

  • 401 — Não autorizado

  • 403 — Acesso negado

  • 404 — Não encontrado