API de equipo - Amazon Managed Grafana
Búsqueda de equipos con paginaciónObtenga el equipo por IDAñadir un equipoActualizar equipoEliminar equipo por IDBusca a los miembros del equipoAñadir miembro del equipoEliminar miembro del equipoObtén las preferencias del equipoActualiza las preferencias del equipo

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

API de equipo

Usa la API de equipo para trabajar con equipos en un espacio de trabajo de Grafana gestionado por Amazon. Todas las acciones de esta API requieren que tengas el rol de administrador.

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.

Búsqueda de equipos con paginación

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

o

GET /api/teams/search?name=myteam

Ejemplo de solicitud

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

Uso del parámetro de consulta

El valor predeterminado del perpage parámetro es 1000 y el del page parámetro es 1.

El totalCount campo de la respuesta se puede utilizar para la paginación de la lista de equipos. Por ejemplo, si totalCount es 100 equipos y el perpage parámetro está establecido en 10, entonces hay 10 páginas de equipos.

El query parámetro es opcional y devuelve los resultados si el valor de la consulta está incluido en el name campo. Los valores de consulta con espacios deben estar codificados en URL. Por ejemplo, query=my%20team.

Uso del parámetro de nombre

El name parámetro devuelve un solo equipo si el parámetro coincide con el name campo.

Ejemplo de respuesta

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

Códigos de estado:

  • 200 — Creado

  • 401 — No autorizado

  • 403 — Permiso denegado

  • 404 — No se ha encontrado el equipo (si se busca por nombre)

Obtenga el equipo por ID

GET /api/teams/:id

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Añadir un equipo

La name del equipo debe ser única. El name campo es obligatorio y los orgId campos email y son opcionales.

POST /api/teams

Ejemplo de solicitud

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

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

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

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

Códigos de estado:

  • 200 — Creado

  • 401 — No autorizado

  • 403 — Permiso denegado

  • 409 — El nombre del equipo ya existe

Actualizar equipo

PUT /api/teams/:id

Solo se pueden actualizar email los campos name y.

Ejemplo de solicitud

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

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

{"message":"Team updated"}

Códigos de estado:

  • 200 — Creado

  • 401 — No autorizado

  • 403 — Permiso denegado

  • 404 — No se encontró el equipo

  • 409 — El nombre del equipo ya existe

Eliminar equipo por ID

DELETE /api/teams/:id

Ejemplo de solicitud

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

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

{"message":"Team deleted"}

Códigos de estado:

  • 200 — Creado

  • 401 — No autorizado

  • 403 — Permiso denegado

  • 404 — No se encontró el equipo

Busca a los miembros del equipo

GET /api/teams/:teamId/members

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Códigos de estado:

  • 200 — Creado

  • 401 — No autorizado

  • 403 — Permiso denegado

Añadir miembro del equipo

POST /api/teams/:teamId/members

Ejemplo de solicitud

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

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

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

Códigos de estado:

  • 200 — Creado

  • 400 — El usuario ya está en el equipo

  • 401 — No autorizado

  • 403 — Permiso denegado

  • 404 — No se encontró el equipo

Eliminar miembro del equipo

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

Ejemplo de solicitud

DELETE /api/teams/2/members/3 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

{"message":"Team Member removed"}

Códigos de estado:

  • 200 — Creado

  • 401 — No autorizado

  • 403 — Permiso denegado

  • 404 — No se encontró el equipo/no se encontró a un miembro del equipo

Obtén las preferencias del equipo

GET /api/teams/:teamId/preferences

Ejemplo de solicitud

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

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

{
  "theme": "",
  "homeDashboardId": 0,
  "timezone": ""
}

Actualiza las preferencias del equipo

PUT /api/teams/:teamId/preferences

Ejemplo de solicitud

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 de JSON:

  • tema: especifique una cadena vacía o una cadena vacía para usar el tema predeterminado. light dark

  • homeDashboardId— El número :id de un cuadro de mando. El valor predeterminado es 0.

  • zona horaria: especifique una cadena vacía o una cadena vacía para utilizar la predeterminada. utc browser

Si se omite un parámetro, el valor actual se sustituye por el valor predeterminado del sistema.

Ejemplo de respuesta

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

{
  "message":"Preferences updated"
}