View a markdown version of this page

API de lista de reproducción - Amazon Managed Grafana
Lista de listas de reproducciónObtén una lista de reproducciónCreación de una lista de reproducciónActualización de una lista de reproducciónEliminación de una lista de reproducciónBusca una lista de reproducción (obsoleta)Obtenga una lista de reproducción (obsoleta)Obtener los elementos de la lista de reproducción (obsoleto)Obtenga los paneles de las listas de reproducción (en desuso)Crear una lista de reproducción (obsoleto)Actualizar una lista de reproducción (obsoleto)Eliminar una lista de reproducción (obsoleto)

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 lista de reproducción

Use la API de lista de reproducción para trabajar con las listas de reproducción en el espacio de trabajo de Amazon Managed Grafana.

nota

Para usar una API de Grafana con tu espacio de trabajo de Grafana gestionado por Amazon, debes tener un token de cuenta de servicio válido. Lo incluye en el campo Authorization de la solicitud de API.

Lista de listas de reproducción

GET /apis/playlist.grafana.app/v1/namespaces/default/playlists

Muestra todas las listas de reproducción del espacio de trabajo.

Ejemplo de solicitud

GET /apis/playlist.grafana.app/v1/namespaces/default/playlists HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

{
  "kind": "PlaylistList",
  "apiVersion": "playlist.grafana.app/v1",
  "metadata": {},
  "items": [
    {
      "kind": "Playlist",
      "apiVersion": "playlist.grafana.app/v1",
      "metadata": {
        "name": "my-playlist-uid",
        "namespace": "default"
      },
      "spec": {
        "title": "My Playlist",
        "interval": "5m",
        "items": [
          {"type": "dashboard_by_uid", "value": "dashboard-uid-1"}
        ]
      }
    }
  ]
}

Obtén una lista de reproducción

GET /apis/playlist.grafana.app/v1/namespaces/default/playlists/:name

Recupera una lista de reproducción específica por nombre (UID).

Ejemplo de solicitud

GET /apis/playlist.grafana.app/v1/namespaces/default/playlists/my-playlist-uid HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

{
  "kind": "Playlist",
  "apiVersion": "playlist.grafana.app/v1",
  "metadata": {
    "name": "my-playlist-uid",
    "namespace": "default"
  },
  "spec": {
    "title": "My Playlist",
    "interval": "5m",
    "items": [
      {"type": "dashboard_by_uid", "value": "dashboard-uid-1"}
    ]
  }
}

Creación de una lista de reproducción

POST /apis/playlist.grafana.app/v1/namespaces/default/playlists

Crea una nueva lista de reproducción.

Ejemplo de solicitud

POST /apis/playlist.grafana.app/v1/namespaces/default/playlists HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "metadata": {"name": "my-new-playlist-uid"},
  "spec": {
    "title": "My New Playlist",
    "interval": "5m",
    "items": [
      {"type": "dashboard_by_uid", "value": "dashboard-uid-1"}
    ]
  }
}

Actualización de una lista de reproducción

PUT /apis/playlist.grafana.app/v1/namespaces/default/playlists/:name

Actualiza una lista de reproducción existente. Se deben proporcionar todas las especificaciones de la lista de reproducción.

Ejemplo de solicitud

PUT /apis/playlist.grafana.app/v1/namespaces/default/playlists/my-playlist-uid HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "metadata": {
    "name": "my-playlist-uid",
    "resourceVersion": "1234567890"
  },
  "spec": {
    "title": "Updated Playlist",
    "interval": "10m",
    "items": [
      {"type": "dashboard_by_uid", "value": "dashboard-uid-1"},
      {"type": "dashboard_by_tag", "value": "monitoring"}
    ]
  }
}

Eliminación de una lista de reproducción

DELETE /apis/playlist.grafana.app/v1/namespaces/default/playlists/:name

Elimina una lista de reproducción por su nombre (UID).

Ejemplo de solicitud

DELETE /apis/playlist.grafana.app/v1/namespaces/default/playlists/my-playlist-uid HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

{
  "kind": "Status",
  "apiVersion": "v1",
  "status": "Success",
  "code": 200
}
importante

Este punto final está obsoleto. En su lugar, use Lista de listas de reproducción.

GET /api/playlists

Devuelve todas las listas de reproducción del espacio de trabajo actual de Amazon Managed Grafana mediante paginación.

Ejemplo de solicitud

GET /api/playlists HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Parámetros de cadenas de consulta:

  • query: limite las respuestas a las listas de reproducción que tengan un nombre como este valor.

  • limit: limite la respuesta a un número X de listas de reproducción.

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json
[
  {
    "id": 1,
    "name": "my playlist",
    "interval": "5m"
  }
]

Obtenga una lista de reproducción (obsoleta)

importante

Este punto final está obsoleto. En su lugar, use Obtén una lista de reproducción.

GET /api/playlists/:id

Ejemplo de solicitud

GET /api/playlists/1 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json
{
  "id" : 1,
  "name": "my playlist",
  "interval": "5m",
  "orgId": "my org",
  "items": [
    {
      "id": 1,
      "playlistId": 1,
      "type": "dashboard_by_id",
      "value": "3",
      "order": 1,
      "title":"my third dashboard"
    },
    {
      "id": 2,
      "playlistId": 1,
      "type": "dashboard_by_tag",
      "value": "myTag",
      "order": 2,
      "title":"my other dashboard"
    }
  ]
}

Obtener los elementos de la lista de reproducción (obsoleto)

importante

Este punto final está obsoleto. En su lugar, use Obtén una lista de reproducción. Los elementos de la lista de reproducción se incluyen en la respuesta de la lista de reproducción.

GET /api/playlists/:id/items

Ejemplo de solicitud

GET /api/playlists/1/items HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json
[
  {
    "id": 1,
    "playlistId": 1,
    "type": "dashboard_by_id",
    "value": "3",
    "order": 1,
    "title":"my third dashboard"
  },
  {
    "id": 2,
    "playlistId": 1,
    "type": "dashboard_by_tag",
    "value": "myTag",
    "order": 2,
    "title":"my other dashboard"
  }
]

Obtenga los paneles de las listas de reproducción (en desuso)

importante

Este punto final está obsoleto. En su lugar, use Obtén una lista de reproducción.

GET /api/playlists/:id/dashboards

Ejemplo de solicitud

GET /api/playlists/1/dashboards HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json
[
  {
    "id": 3,
    "title": "my third dashboard",
    "order": 1,
  },
  {
    "id": 5,
    "title":"my other dashboard"
    "order": 2,

  }
]

Crear una lista de reproducción (obsoleto)

importante

Este punto final está obsoleto. En su lugar, use Creación de una lista de reproducción.

POST /api/playlists/

Ejemplo de solicitud

PUT /api/playlists/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
  {
    "name": "my playlist",
    "interval": "5m",
    "items": [
      {
        "type": "dashboard_by_id",
        "value": "3",
        "order": 1,
        "title":"my third dashboard"
      },
      {
        "type": "dashboard_by_tag",
        "value": "myTag",
        "order": 2,
        "title":"my other dashboard"
      }
    ]
  }

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json
  {
    "id": 1,
    "name": "my playlist",
    "interval": "5m"
  }

Actualizar una lista de reproducción (obsoleto)

importante

Este punto final está obsoleto. En su lugar, use Actualización de una lista de reproducción.

PUT /api/playlists/:id

Ejemplo de solicitud

PUT /api/playlists/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
  {
    "name": "my playlist",
    "interval": "5m",
    "items": [
      {
        "playlistId": 1,
        "type": "dashboard_by_id",
        "value": "3",
        "order": 1,
        "title":"my third dashboard"
      },
      {
        "playlistId": 1,
        "type": "dashboard_by_tag",
        "value": "myTag",
        "order": 2,
        "title":"my other dashboard"
      }
    ]
  }

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json
{
  "id" : 1,
  "name": "my playlist",
  "interval": "5m",
  "orgId": "my org",
  "items": [
    {
      "id": 1,
      "playlistId": 1,
      "type": "dashboard_by_id",
      "value": "3",
      "order": 1,
      "title":"my third dashboard"
    },
    {
      "id": 2,
      "playlistId": 1,
      "type": "dashboard_by_tag",
      "value": "myTag",
      "order": 2,
      "title":"my other dashboard"
    }
  ]
}

Eliminar una lista de reproducción (obsoleto)

importante

Este punto final está obsoleto. En su lugar, use Eliminación de una lista de reproducción.

DELETE /api/playlists/:id

Ejemplo de solicitud

DELETE /api/playlists/1 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json
{}