API de preferências - Amazon Managed Grafana

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 preferências

Use a API Preferences para trabalhar com as preferências do usuário no espaço de trabalho Amazon Managed Grafana.

Chaves:

  • tema — Os valores válidos são lightdark,, ou uma string vazia para usar o tema padrão.

  • homeDashboardId— O número :id de um painel favorito. O padrão é 0.

  • fuso horário — Os valores válidos são utcbrowser,, ou uma string vazia para usar o padrão.

A omissão de uma chave faz com que o valor atual seja substituído pelo valor padrão do sistema.

nota

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

Obtenha as preferências atuais do usuário

GET /api/user/preferences

Exemplo de solicitação

GET /api/user/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Exemplo de resposta

HTTP/1.1 200 Content-Type: application/json {"theme":"","homeDashboardId":0,"timezone":""}

Atualizar as preferências atuais do usuário

PUT /api/user/preferences

Exemplo de solicitação

PUT /api/user/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "theme": "", "homeDashboardId":0, "timezone":"utc" }

Exemplo de resposta

HTTP/1.1 200 Content-Type: text/plain; charset=utf-8 {"message":"Preferences updated"}

Obtenha as preferências atuais da organização

GET /api/org/preferences

Exemplo de solicitação

GET /api/org/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Exemplo de resposta

HTTP/1.1 200 Content-Type: application/json {"theme":"","homeDashboardId":0,"timezone":""}

Atualizar as preferências atuais da organização

PUT /api/org/preferences

Exemplo de solicitação

PUT /api/org/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "theme": "", "homeDashboardId":0, "timezone":"utc" }

Exemplo de resposta

HTTP/1.1 200 Content-Type: text/plain; charset=utf-8 {"message":"Preferences updated"}