View a markdown version of this page

API Daftar Putar - Amazon Managed Grafana
Daftar playlistDapatkan daftar putarBuat daftar putarMemperbarui daftar putarMenghapus daftar putarCari daftar putar (tidak digunakan lagi)Dapatkan satu daftar putar (tidak digunakan lagi)Dapatkan item daftar putar (tidak digunakan lagi)Dapatkan dasbor daftar putar (tidak digunakan lagi)Buat daftar putar (tidak digunakan lagi)Memperbarui daftar putar (tidak digunakan lagi)Menghapus daftar putar (tidak digunakan lagi)

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

API Daftar Putar

Gunakan API Daftar Putar untuk bekerja dengan daftar putar di ruang kerja Grafana Terkelola Amazon.

catatan

Untuk menggunakan API Grafana dengan ruang kerja Grafana yang Dikelola Amazon, Anda harus memiliki token akun layanan yang valid. Anda menyertakan ini di Authorization bidang dalam permintaan API.

Daftar playlist

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

Daftar semua daftar putar di ruang kerja.

Permintaan contoh

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

Contoh respon

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

Dapatkan daftar putar

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

Mengambil daftar putar tertentu dengan nama (UID).

Permintaan contoh

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

Contoh respon

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

Buat daftar putar

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

Membuat daftar putar baru.

Permintaan contoh

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

Memperbarui daftar putar

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

Memperbarui daftar putar yang ada. Seluruh spesifikasi daftar putar harus disediakan.

Permintaan contoh

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

Menghapus daftar putar

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

Menghapus daftar putar dengan nama (UID).

Permintaan contoh

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

Contoh respon

HTTP/1.1 200
Content-Type: application/json

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

Titik akhir ini tidak digunakan lagi. Gunakan Daftar playlist sebagai gantinya.

GET /api/playlists

Mengembalikan semua daftar putar untuk ruang kerja Grafana Terkelola Amazon saat ini, menggunakan pagination.

Permintaan contoh

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

Parameter Querystring:

  • query — Batasi respons ke daftar putar yang memiliki nama seperti nilai ini.

  • limit — Batasi respons ke X jumlah playlist.

Contoh respon

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

Dapatkan satu daftar putar (tidak digunakan lagi)

penting

Titik akhir ini tidak digunakan lagi. Gunakan Dapatkan daftar putar sebagai gantinya.

GET /api/playlists/:id

Permintaan contoh

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

Contoh respon

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

Dapatkan item daftar putar (tidak digunakan lagi)

penting

Titik akhir ini tidak digunakan lagi. Gunakan Dapatkan daftar putar sebagai gantinya. Item daftar putar disertakan dalam respons daftar putar.

GET /api/playlists/:id/items

Permintaan contoh

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

Contoh respon

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

Dapatkan dasbor daftar putar (tidak digunakan lagi)

penting

Titik akhir ini tidak digunakan lagi. Gunakan Dapatkan daftar putar sebagai gantinya.

GET /api/playlists/:id/dashboards

Permintaan contoh

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

Contoh respon

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

  }
]

Buat daftar putar (tidak digunakan lagi)

penting

Titik akhir ini tidak digunakan lagi. Gunakan Buat daftar putar sebagai gantinya.

POST /api/playlists/

Permintaan contoh

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

Contoh respon

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

Memperbarui daftar putar (tidak digunakan lagi)

penting

Titik akhir ini tidak digunakan lagi. Gunakan Memperbarui daftar putar sebagai gantinya.

PUT /api/playlists/:id

Permintaan contoh

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

Contoh respon

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

Menghapus daftar putar (tidak digunakan lagi)

penting

Titik akhir ini tidak digunakan lagi. Gunakan Menghapus daftar putar sebagai gantinya.

DELETE /api/playlists/:id

Permintaan contoh

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

Contoh respon

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