View a markdown version of this page

재생 목록 API - Amazon Managed Grafana
재생 목록 나열재생 목록 가져오기재생 목록 생성재생 목록 업데이트재생 목록 삭제검색 재생 목록(사용되지 않음)재생 목록 하나 가져오기(사용되지 않음)재생 목록 항목 가져오기(사용되지 않음)재생 목록 대시보드 가져오기(사용되지 않음)재생 목록 생성(사용되지 않음)재생 목록 업데이트(사용되지 않음)재생 목록 삭제(사용되지 않음)

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

재생 목록 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
}
중요

이 엔드포인트는 더 이상 사용되지 않습니다. 대신 재생 목록 나열을 사용하세요.

GET /api/playlists

페이지 매김 기능을 사용하여 현재 Amazon Managed Grafana 워크스페이스의 모든 재생 목록을 반환합니다.

요청 예제

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

쿼리 문자열 파라미터:

  • query - 이 값과 같은 이름의 재생 목록으로 응답을 제한합니다.

  • limit - X개의 재생 목록으로 응답을 제한합니다.

응답의 예

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

재생 목록 하나 가져오기(사용되지 않음)

중요

이 엔드포인트는 더 이상 사용되지 않습니다. 대신 재생 목록 가져오기을 사용하세요.

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

재생 목록 항목 가져오기(사용되지 않음)

중요

이 엔드포인트는 더 이상 사용되지 않습니다. 대신 재생 목록 가져오기을 사용하세요. 재생 목록 항목은 재생 목록 응답에 포함됩니다.

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

재생 목록 대시보드 가져오기(사용되지 않음)

중요

이 엔드포인트는 더 이상 사용되지 않습니다. 대신 재생 목록 가져오기을 사용하세요.

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,

  }
]

재생 목록 생성(사용되지 않음)

중요

이 엔드포인트는 더 이상 사용되지 않습니다. 대신 재생 목록 생성을 사용하세요.

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

재생 목록 업데이트(사용되지 않음)

중요

이 엔드포인트는 더 이상 사용되지 않습니다. 대신 재생 목록 업데이트을 사용하세요.

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

재생 목록 삭제(사용되지 않음)

중요

이 엔드포인트는 더 이상 사용되지 않습니다. 대신 재생 목록 삭제을 사용하세요.

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