Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# API de playlist
Utilisez l'API Playlist pour travailler avec des playlists dans l'espace de travail Amazon Managed Grafana.
**Note**
Pour utiliser une API Grafana avec votre espace de travail Amazon Managed Grafana, vous devez disposer d'un jeton de compte de service valide. Vous l'incluez dans le `Authorization` champ de la demande d'API.
## Lister les playlists
```
GET /apis/playlist.grafana.app/v1/namespaces/default/playlists
```
Répertorie toutes les playlists de l'espace de travail.
**Exemple de demande**
```
GET /apis/playlist.grafana.app/v1/namespaces/default/playlists HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Exemple de réponse**
```
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"}
]
}
}
]
}
```
## Obtenez une playlist
```
GET /apis/playlist.grafana.app/v1/namespaces/default/playlists/:name
```
Récupère une playlist spécifique par son nom (UID).
**Exemple de demande**
```
GET /apis/playlist.grafana.app/v1/namespaces/default/playlists/my-playlist-uid HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Exemple de réponse**
```
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"}
]
}
}
```
## Création d'une playlist
```
POST /apis/playlist.grafana.app/v1/namespaces/default/playlists
```
Crée une nouvelle playlist.
**Exemple de demande**
```
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"}
]
}
}
```
## Mettre à jour une playlist
```
PUT /apis/playlist.grafana.app/v1/namespaces/default/playlists/:name
```
Met à jour une playlist existante. Les spécifications complètes de la playlist doivent être fournies.
**Exemple de demande**
```
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"}
]
}
}
```
## Supprimer une playlist
```
DELETE /apis/playlist.grafana.app/v1/namespaces/default/playlists/:name
```
Supprime une playlist par son nom (UID).
**Exemple de demande**
```
DELETE /apis/playlist.grafana.app/v1/namespaces/default/playlists/my-playlist-uid HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Exemple de réponse**
```
HTTP/1.1 200
Content-Type: application/json
{
"kind": "Status",
"apiVersion": "v1",
"status": "Success",
"code": 200
}
```
## Rechercher une playlist (obsolète)
**Important**
Ce point de terminaison est obsolète. Utilisez [Lister les playlists](#v12-Grafana-API-Playlist-list) à la place.
```
GET /api/playlists
```
Renvoie toutes les playlists de l'espace de travail Amazon Managed Grafana actuel, en utilisant la pagination.
**Exemple de demande**
```
GET /api/playlists HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
Paramètres de chaîne de requête :
+ **query** — Limitez les réponses aux playlists portant un nom similaire à cette valeur.
+ **limit** — Limite la réponse à un nombre X de playlists.
**Exemple de réponse**
```
HTTP/1.1 200
Content-Type: application/json
[
{
"id": 1,
"name": "my playlist",
"interval": "5m"
}
]
```
## Obtenir une playlist (obsolète)
**Important**
Ce point de terminaison est obsolète. Utilisez [Obtenez une playlist](#v12-Grafana-API-Playlist-get) à la place.
```
GET /api/playlists/:id
```
**Exemple de demande**
```
GET /api/playlists/1 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Exemple de réponse**
```
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"
}
]
}
```
## Obtenir des éléments de playlist (obsolète)
**Important**
Ce point de terminaison est obsolète. Utilisez [Obtenez une playlist](#v12-Grafana-API-Playlist-get) à la place. Les éléments de la playlist sont inclus dans la réponse à la playlist.
```
GET /api/playlists/:id/items
```
**Exemple de demande**
```
GET /api/playlists/1/items HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Exemple de réponse**
```
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"
}
]
```
## Obtenir des tableaux de bord de playlists (obsolète)
**Important**
Ce point de terminaison est obsolète. Utilisez [Obtenez une playlist](#v12-Grafana-API-Playlist-get) à la place.
```
GET /api/playlists/:id/dashboards
```
**Exemple de demande**
```
GET /api/playlists/1/dashboards HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Exemple de réponse**
```
HTTP/1.1 200
Content-Type: application/json
[
{
"id": 3,
"title": "my third dashboard",
"order": 1,
},
{
"id": 5,
"title":"my other dashboard"
"order": 2,
}
]
```
## Créer une playlist (obsolète)
**Important**
Ce point de terminaison est obsolète. Utilisez [Création d'une playlist](#v12-Grafana-API-Playlist-create) à la place.
```
POST /api/playlists/
```
**Exemple de demande**
```
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"
}
]
}
```
**Exemple de réponse**
```
HTTP/1.1 200
Content-Type: application/json
{
"id": 1,
"name": "my playlist",
"interval": "5m"
}
```
## Mettre à jour une playlist (obsolète)
**Important**
Ce point de terminaison est obsolète. Utilisez [Mettre à jour une playlist](#v12-Grafana-API-Playlist-update) à la place.
```
PUT /api/playlists/:id
```
**Exemple de demande**
```
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"
}
]
}
```
**Exemple de réponse**
```
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"
}
]
}
```
## Supprimer une playlist (obsolète)
**Important**
Ce point de terminaison est obsolète. Utilisez [Supprimer une playlist](#v12-Grafana-API-Playlist-delete) à la place.
```
DELETE /api/playlists/:id
```
**Exemple de demande**
```
DELETE /api/playlists/1 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Exemple de réponse**
```
HTTP/1.1 200
Content-Type: application/json
{}
```