DescribeShowList - ApsaraVideo Live

Mengambil daftar putar (playlist).

Deskripsi operasi

Sebelum memanggil operasi ini, Anda harus menambahkan sebuah show ke dalam daftar putar. Untuk menambahkan show melalui API, lihat Add a show to a playlist.

Batas QPS

Batas permintaan per detik (QPS) untuk satu pengguna adalah 10. Jika batas ini dilampaui, panggilan API akan dikenai pengendalian aliran (throttled), yang dapat memengaruhi operasi bisnis Anda. Rencanakan panggilan API Anda secara sesuai.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeShowList

get

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-shanghai
CasterId	string	Yes	ID studio produksi. Jika Anda membuat studio produksi dengan memanggil operasi CreateCaster, gunakan nilai CasterId yang dikembalikan dalam respons. Jika Anda membuat studio produksi di Konsol LIVE, pilih LIVE Console > Production Studio > Cloud Production Studio untuk menemukan nama studio produksi tersebut. Catatan Nama studio produksi dalam daftar pada halaman Cloud Production Studio adalah ID studio produksi.	LIVEPRODUCER_POST-cn-0pp1czt****

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
ShowList	string	Detail daftar putar. `Show` berisi detail sebuah show dalam daftar putar.	ShowList[Show1, Show2, Show3...]
ShowListInfo	object	Daftar putar.
CurrentShowId	string	ID show yang sedang diputar.	a2b8e671-2fe5-4642-a2ec-bf93880e****
Background	string	Latar belakang daftar putar.	{\"MaterialId\":\"a2b8e671-2fe5-4642-a2ec-bf93880e****\",\"resourceType\":\"VOD\"}
HighPriorityShowId	string	Show dengan prioritas tertinggi. Catatan Anda hanya dapat mengonfigurasi parameter ini sebelum daftar putar dimulai.	a2b8e671-2fe5-4642-a2ec-bf93880e****
HighPriorityShowStartTime	string	Waktu pemutaran show dengan prioritas tertinggi. Formatnya adalah yyyy-MM-dd'T'HH:mm:ss. Catatan Anda hanya dapat mengonfigurasi parameter ini sebelum daftar putar dimulai. Setelah konfigurasi selesai, sistem akan beralih ke show dengan prioritas tertinggi pada waktu yang ditentukan.	2021-11-23T12:30:00
ShowList	object
Show	array<object>	Daftar show dalam daftar putar.
	array<object>	Detail show.
Duration	integer	Durasi satu show, dalam satuan detik.	20
RepeatTimes	integer	Jumlah kali satu show diulang. Misalnya, nilai 0 berarti show diputar sekali. Nilai 1 berarti show diputar dua kali.	5
ResourceInfo	object	Informasi resource.
LiveInputType	integer	Identifier tipe kustom.	1
ResourceId	string	ID file video sesuai permintaan (VOD).	a2b8e671-2fe5-4642-a2ec-bf93880e****
ResourceType	string	Tipe material resource.	vod
ResourceUrl	string	URL resource.	http:///atestObject.m3u8
ShowId	string	ID show.	a2b8e671-2fe5-4642-a2ec-bf93880e****
ShowName	string	Nama show.	liveShow****
ShowListRepeatTimes	integer	Jumlah default pengulangan daftar putar. Nilai ini selalu 0.	0
TotalShowListRepeatTimes	integer	Jumlah kali seluruh daftar putar diulang.	1

Contoh

Respons sukses

JSONformat

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "ShowList": "ShowList[Show1, Show2, Show3...]",
  "ShowListInfo": {
    "CurrentShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
    "Background": "{\\\"MaterialId\\\":\\\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\\",\\\"resourceType\\\":\\\"VOD\\\"}",
    "HighPriorityShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
    "HighPriorityShowStartTime": "2021-11-23T12:30:00",
    "ShowList": {
      "Show": [
        {
          "Duration": 20,
          "RepeatTimes": 5,
          "ResourceInfo": {
            "LiveInputType": 1,
            "ResourceId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
            "ResourceType": "vod",
            "ResourceUrl": "http://**/atestObject**.m3u8"
          },
          "ShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
          "ShowName": "liveShow****"
        }
      ]
    },
    "ShowListRepeatTimes": 0,
    "TotalShowListRepeatTimes": 1
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidUserId.Malformed	%s, please check userId.
400	InvalidParameter.Malformed	There are invalid parameters: %s.
400	InvalidCasterId.Malformed	%s, please check and try again later.
400	MissingParameter	%s.
401	IllegalOperation	%s, please check and try again later.
500	InternalError	%s, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.
404	InvalidShowList.NotFound	%s, please check and try again later.
404	InvalidShow.NotFound	%s, please check and try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.