Referensi API DescribeShowList untuk detail playlist - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Mengkueri daftar putar.

Deskripsi operasi

Before calling this operation, you must add a show to the playlist. To add a show by calling an API operation, see Add a show to a playlist.

QPS limit

The queries per second (QPS) limit for a single user is 10. If the limit is exceeded, API calls are throttled. This may affect your business operations. Plan your calls accordingly.

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 di tanggapan. Jika Anda membuat studio produksi di Konsol ApsaraVideo Live, pilih Konsol ApsaraVideo Live > Studio Produksi > Cloud Production Studio untuk mencari nama studio produksi. Catatan Nama studio produksi pada daftar di halaman Cloud Production Studio adalah ID studio produksi.	LIVEPRODUCER_POST-cn-0pp1czt****

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
ShowList	string	The details of the playlist. `Show` contains the details of a show in the playlist.	ShowList[Show1, Show2, Show3...]
ShowListInfo	object	The playlist.
CurrentShowId	string	The ID of the show that is being played.	a2b8e671-2fe5-4642-a2ec-bf93880e****
Background	string	The background of the playlist.	{\"MaterialId\":\"a2b8e671-2fe5-4642-a2ec-bf93880e****\",\"resourceType\":\"VOD\"}
HighPriorityShowId	string	The highest-priority show. Catatan You can configure this parameter only before the playlist starts.	a2b8e671-2fe5-4642-a2ec-bf93880e****
HighPriorityShowStartTime	string	The time when the highest-priority show is played. The format is yyyy-MM-dd'T'HH:mm:ss. Catatan You can configure this parameter only before the playlist starts. After the configuration is complete, the system switches to the highest-priority show at the specified time.	2021-11-23T12:30:00
ShowList	object
Show	array<object>	The list of shows in the playlist.
	array<object>	The details of the show.
Duration	integer	The duration of a single show, in seconds.	20
RepeatTimes	integer	The number of times a single show is looped. For example, a value of 0 indicates that the show is played once. A value of 1 indicates that the show is played twice.	5
ResourceInfo	object	The resource information.
LiveInputType	integer	The custom type identifier.	1
ResourceId	string	The ID of the video-on-demand (VOD) file.	a2b8e671-2fe5-4642-a2ec-bf93880e****
ResourceType	string	The type of the resource material.	vod
ResourceUrl	string	The URL of the resource.	http:///atestObject.m3u8
ShowId	string	The ID of the show.	a2b8e671-2fe5-4642-a2ec-bf93880e****
ShowName	string	The name of the show.	liveShow****
ShowListRepeatTimes	integer	The default number of loops for the playlist. This value is always 0.	0
TotalShowListRepeatTimes	integer	The number of times the entire playlist is looped.	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.