API de equipe - Amazon Managed Grafana
Pesquisa em equipe com paginaçãoConsiga uma equipe por IDAdicionar uma equipeEquipe de atualizaçãoExcluir equipe por IDConsiga membros da equipeAdicionar membro da equipeRemover membro da equipeObter as preferências da equipeAtualizar as preferências da equipe

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 equipe

Use a API Team para trabalhar com equipes em um espaço de trabalho Amazon Managed Grafana. Todas as ações nessa API exigem que você tenha a função de administrador.

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.

Pesquisa em equipe com paginação

GET /api/teams/search?perpage=50&page=1&query=myteam

or

GET /api/teams/search?name=myteam

Exemplo de solicitação

GET /api/teams/search?perpage=10&page=1&query=myteam HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Usando o parâmetro de consulta

O valor padrão para operpage parâmetro é 1000 e para opage parâmetro é 1.

OtotalCount campo na resposta pode ser usado para paginação da lista de equipes. Por exemplo, setotalCount for 100 equipes e operpage parâmetro estiver definido como 10, então há 10 páginas de equipes.

Oquery parâmetro é opcional e retorna resultados em que o valor da consulta está contido noname campo. Valores de consulta com espaços precisam ser codificados em URL. Por exemplo, query=my%20team.

Usando o parâmetro name

Oname parâmetro retornará uma única equipe se o parâmetro corresponder aoname campo.

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

{
  "totalCount": 1,
  "teams": [
    {
      "id": 1,
      "orgId": 1,
      "name": "MyTestTeam",
      "email": "",
      "avatarUrl": "\/avatar\/3f49c15916554246daa714b9bd0ee39",
      "memberCount": 1
    }
  ],
  "page": 1,
  "perPage": 1000

HTTP Status Codes

  • 200 — Criado

  • 401 — Não autorizado

  • 403 — Permissão negada

  • 404 — Equipe não encontrada (se estiver pesquisando por nome)

Consiga uma equipe por ID

GET /api/teams/:id

Exemplo de solicitação

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

Exemplo de resposta

HHTTP/1.1 200
Content-Type: application/json

{
  "id": 1,
  "orgId": 1,
  "name": "MyTestTeam",
  "email": "",
  "created": "2017-12-15T10:40:45+01:00",
  "updated": "2017-12-15T10:40:45+01:00"
}

Adicionar uma equipe

O membroname da equipe deve ser exclusivo. Oname campo é obrigatório e osorgId camposemail e são opcionais.

POST /api/teams

Exemplo de solicitação

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

{
  "name": "MyTestTeam",
  "email": "email@test.com",
  "orgId": 2
}

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

{"message":"Team created","teamId":2}

HTTP Status Codes

  • 200 — Criado

  • 401 — Não autorizado

  • 403 — Permissão negada

  • 409 — O nome da equipe já existe

Equipe de atualização

PUT /api/teams/:id

Somente osemail camposname e podem ser atualizados.

Exemplo de solicitação

PUT /api/teams/2 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
        
{
  "name": "MyTestTeam",
  "email": "email@test.com"
}

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

{"message":"Team updated"}

HTTP Status Codes

  • 200 — Criado

  • 401 — Não autorizado

  • 403 — Permissão negada

  • 404 — Equipe não encontrada

  • 409 — O nome da equipe já existe

Excluir equipe por ID

DELETE /api/teams/:id

Exemplo de solicitação

DELETE /api/teams/2 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":"Team deleted"}

HTTP Status Codes

  • 200 — Criado

  • 401 — Não autorizado

  • 403 — Permissão negada

  • 404 — Equipe não encontrada

Consiga membros da equipe

GET /api/teams/:teamId/members

Exemplo de solicitação

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

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

[
  {
    "orgId": 1,
    "teamId": 1,
    "userId": 3,
    "email": "user1@email.com",
    "login": "user1",
    "avatarUrl": "\/avatar\/1b3c32f6386b0185c40d359cdc733a7"
  },
  {
    "orgId": 1,
    "teamId": 1,
    "userId": 2,
    "email": "user2@email.com",
    "login": "user2",
    "avatarUrl": "\/avatar\/cad3c68da76e45d10269e8ef02f8e7"
  }
]

HTTP Status Codes

  • 200 — Criado

  • 401 — Não autorizado

  • 403 — Permissão negada

Adicionar membro da equipe

POST /api/teams/:teamId/members

Exemplo de solicitação

POST /api/teams/1/members HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
      
{
  "userId": 2
}

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

{"message":"Member added to Team"}

HTTP Status Codes

  • 200 — Criado

  • 400 — O usuário já está na equipe

  • 401 — Não autorizado

  • 403 — Permissão negada

  • 404 — Equipe não encontrada

Remover membro da equipe

DELETE /api/teams/:teamId/members/:userId

Exemplo de solicitação

DELETE /api/teams/2/members/3 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":"Team Member removed"}

HTTP Status Codes

  • 200 — Criado

  • 401 — Não autorizado

  • 403 — Permissão negada

  • 404 — Equipe não encontrada/Membro da equipe não encontrado

Obter as preferências da equipe

GET /api/teams/:teamId/preferences

Exemplo de solicitação

GET /api/teams/2/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 da equipe

PUT /api/teams/:teamId/preferences

Exemplo de solicitação

PUT /api/teams/2/preferences HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "theme": "dark",
  "homeDashboardId": 39,
  "timezone": "utc"
}

Esquema corporal JSON:

  • tema — Especifique uma string vazia ou uma string vazia para usar o tema padrão.lightdark

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

  • fuso horário — Especifique uma string vazia ou uma string vazia para usar o padrão.utcbrowser

A omissão de um parâmetro faz com que o valor atual seja substituído pelo valor padrão do sistema.

Exemplo de resposta

HTTP/1.1 200
Content-Type: text/plain; charset=utf-8

{
  "message":"Preferences updated"
}