翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # プレイリスト API プレイリスト API を使用して Amazon Managed Grafana ワークスペースのプレイリストを操作します。 **注記** Amazon Managed Grafana ワークスペースで Grafana API を使用するには、有効なサービスアカウントトークンが必要です。このトークンは API リクエストの `Authorization` フィールドに含めます。 ## プレイリストを一覧表示する ``` GET /apis/playlist.grafana.app/v1/namespaces/default/playlists ``` ワークスペース内のすべてのプレイリストを一覧表示します。 **リクエストの例** ``` GET /apis/playlist.grafana.app/v1/namespaces/default/playlists HTTP/1.1 Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` **レスポンスの例** ``` 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"} ] } } ] } ``` ## プレイリストを取得する ``` GET /apis/playlist.grafana.app/v1/namespaces/default/playlists/:name ``` 特定のプレイリストを名前 (UID) で取得します。 **リクエストの例** ``` GET /apis/playlist.grafana.app/v1/namespaces/default/playlists/my-playlist-uid HTTP/1.1 Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` **レスポンスの例** ``` 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"} ] } } ``` ## プレイリストの作成 ``` POST /apis/playlist.grafana.app/v1/namespaces/default/playlists ``` 新しいプレイリストを作成します。 **リクエストの例** ``` 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"} ] } } ``` ## プレイリストの更新 ``` PUT /apis/playlist.grafana.app/v1/namespaces/default/playlists/:name ``` 既存のプレイリストを更新します。プレイリスト仕様全体を指定する必要があります。 **リクエストの例** ``` 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"} ] } } ``` ## プレイリストの削除 ``` DELETE /apis/playlist.grafana.app/v1/namespaces/default/playlists/:name ``` プレイリストを名前 (UID) で削除します。 **リクエストの例** ``` DELETE /apis/playlist.grafana.app/v1/namespaces/default/playlists/my-playlist-uid HTTP/1.1 Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` **レスポンスの例** ``` HTTP/1.1 200 Content-Type: application/json { "kind": "Status", "apiVersion": "v1", "status": "Success", "code": 200 } ``` ## 検索プレイリスト (廃止) **重要** このエンドポイントは廃止されました。代わりに [プレイリストを一覧表示する](#v12-Grafana-API-Playlist-list) を使用します。 ``` GET /api/playlists ``` ページ分割を使用して、現在の Amazon Managed Grafana ワークスペースのプレイリストすべてを返します。 **リクエストの例** ``` GET /api/playlists HTTP/1.1 Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` クエリ文字列パラメータ: + **query** — この値のような名前のプレイリストにレスポンスを制限します。 + **[制限]** — X 個のプレイリストにレスポンスを制限します。 **レスポンスの例** ``` HTTP/1.1 200 Content-Type: application/json [ { "id": 1, "name": "my playlist", "interval": "5m" } ] ``` ## プレイリストを 1 つ取得する (廃止) **重要** このエンドポイントは廃止されました。代わりに [プレイリストを取得する](#v12-Grafana-API-Playlist-get) を使用します。 ``` GET /api/playlists/:id ``` **リクエストの例** ``` GET /api/playlists/1 HTTP/1.1 Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` **レスポンスの例** ``` 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" } ] } ``` ## プレイリスト項目の取得 (廃止) **重要** このエンドポイントは廃止されました。代わりに [プレイリストを取得する](#v12-Grafana-API-Playlist-get) を使用します。プレイリスト項目はプレイリストレスポンスに含まれます。 ``` GET /api/playlists/:id/items ``` **リクエストの例** ``` GET /api/playlists/1/items HTTP/1.1 Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` **レスポンスの例** ``` 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" } ] ``` ## プレイリストダッシュボードを取得する (廃止) **重要** このエンドポイントは廃止されました。代わりに [プレイリストを取得する](#v12-Grafana-API-Playlist-get) を使用します。 ``` GET /api/playlists/:id/dashboards ``` **リクエストの例** ``` GET /api/playlists/1/dashboards HTTP/1.1 Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` **レスポンスの例** ``` HTTP/1.1 200 Content-Type: application/json [ { "id": 3, "title": "my third dashboard", "order": 1, }, { "id": 5, "title":"my other dashboard" "order": 2, } ] ``` ## プレイリストを作成する (廃止) **重要** このエンドポイントは廃止されました。代わりに [プレイリストの作成](#v12-Grafana-API-Playlist-create) を使用します。 ``` POST /api/playlists/ ``` **リクエストの例** ``` 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" } ] } ``` **レスポンスの例** ``` HTTP/1.1 200 Content-Type: application/json { "id": 1, "name": "my playlist", "interval": "5m" } ``` ## プレイリストを更新する (廃止) **重要** このエンドポイントは廃止されました。代わりに [プレイリストの更新](#v12-Grafana-API-Playlist-update) を使用します。 ``` PUT /api/playlists/:id ``` **リクエストの例** ``` 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" } ] } ``` **レスポンスの例** ``` 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" } ] } ``` ## プレイリストを削除する (廃止) **重要** このエンドポイントは廃止されました。代わりに [プレイリストの削除](#v12-Grafana-API-Playlist-delete) を使用します。 ``` DELETE /api/playlists/:id ``` **リクエストの例** ``` DELETE /api/playlists/1 HTTP/1.1 Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` **レスポンスの例** ``` HTTP/1.1 200 Content-Type: application/json {} ```