API de carpetas - Amazon Managed Grafana
Crear carpetaCarpeta de actualizaciónObtenga todas las carpetasObtenga la carpeta por uidObtener la carpeta por IDEliminar carpeta por uid

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 carpetas

Usa la API de carpetas para trabajar con las carpetas del espacio de trabajo de Grafana gestionado por Amazon.

El identificador (id) de una carpeta es un valor numérico que se incrementa automáticamente y solo es único por espacio de trabajo. El identificador único (uid) de una carpeta se puede utilizar para identificar de forma única una carpeta entre varios espacios de trabajo. Se genera automáticamente si no lo proporcionas al crear una carpeta. El uid permite disponer de URL coherentes para acceder a la carpeta y para sincronizar la carpeta entre varios espacios de trabajo de Grafana gestionados por Amazon. El uso del uid significa que al cambiar el título de una carpeta no se interrumpe ningún enlace marcado a esa carpeta.

El uid puede tener una longitud máxima de 40 caracteres.

Las carpetas no se pueden anidar.

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.

La carpeta General, cuyo valor es 0, no forma parte de la API de carpetas. id No puedes usar la API de carpetas para recuperar información sobre la carpeta general.

Crear carpeta

POST /api/folders

Crea una carpeta nueva.

Ejemplo de solicitud

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

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

Esquema de cuerpo de JSON:

  • uid: identificador único opcional. Si es nulo, se genera un nuevo uid.

  • title: el título de la carpeta.

Ejemplo de respuesta

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
}

Códigos de estado:

  • 200 — Creado

  • 400 — Error como un JSON no válido, campos no válidos o faltantes

  • 401 — No autorizado

  • 403 — Acceso denegado

Carpeta de actualización

PUT /api/folders/:uid

Actualiza la carpeta existente que coincide con el uid.

Ejemplo de solicitud

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

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

Esquema de cuerpo de JSON:

  • uid: cambia el identificador único, si se proporciona.

  • title: el título de la carpeta.

  • versión: proporcione la versión actual para poder sobrescribir la carpeta. No es necesario sioverwrite=true.

  • sobrescribir: se configura en true para sobrescribir la carpeta existente con una versión más reciente.

Ejemplo de respuesta

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
}

Códigos de estado:

  • 200 — Creado

  • 400 — Error como un JSON no válido, campos no válidos o faltantes

  • 401 — No autorizado

  • 403 — Acceso denegado

  • 404 — No se encontró la carpeta

  • 412 — Error en la condición previa

El código de estado 412 se utiliza para explicar por qué no se puede actualizar la carpeta.

  • Otra persona ha cambiado la carpeta status=version-mismatch

El cuerpo de la respuesta tiene las siguientes propiedades:

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

Obtenga todas las carpetas

GET /api/folders

Devuelve todas las carpetas para las que tiene permiso de visualización. Puede controlar el número máximo de carpetas devueltas mediante el parámetro de limit consulta. El valor predeterminado es 1000.

Ejemplo de solicitud

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

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

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

Obtenga la carpeta por uid

GET /api/folders/:uid

Devuelve todas las carpetas que coinciden con el uid dado.

Ejemplo de solicitud

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

Ejemplo de respuesta

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
}

Códigos de estado:

  • 200 — Encontrado

  • 401 — No autorizado

  • 403 — Acceso denegado

  • 404 — No se ha encontrado

Obtener la carpeta por ID

GET /api/folders/id/:id

Devuelve la carpeta que coincide con el identificador indicado.

Ejemplo de solicitud

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

Ejemplo de respuesta

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
}

Códigos de estado:

  • 200 — Encontrado

  • 401 — No autorizado

  • 403 — Acceso denegado

  • 404 — No se ha encontrado

Eliminar carpeta por uid

DELETE /api/folders/:uid

Elimina la carpeta que coincide con el uid y también elimina todos los paneles almacenados en la carpeta. Esta operación no se puede revertir.

Ejemplo de solicitud

DELETE /api/folders/nErXDvCkzz 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":"Folder deleted",
  "id": 2
}

Códigos de estado:

  • 200 — Eliminado

  • 401 — No autorizado

  • 403 — Acceso denegado

  • 404 — No se ha encontrado