Manage Playlist Item melalui API AddPlaylistItems - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Deskripsi operasi

Buat studio produksi, tambahkan tata letak studio produksi dan komponen studio produksi, lalu panggil operasi ini untuk menambahkan item daftar putar. Jika belum ada daftar putar yang dibuat, sistem akan membuatnya secara otomatis. Untuk membuat studio produksi menggunakan operasi API, lihat CreateCaster.

Batas QPS

Batas QPS per pengguna tunggal untuk operasi ini adalah 10 panggilan per detik. Jika batas terlampaui, panggilan API akan dibatasi (throttled), yang dapat memengaruhi bisnis Anda. Panggil operasi ini dengan bijak.

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:AddPlaylistItems

create

*Caster.

acs:live:*:{#accountId}:caster/{#CasterId}

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, periksa nilai parameter CasterId yang dikembalikan oleh operasi CreateCaster. Jika Anda membuat studio produksi di Konsol ApsaraVideo Live, navigasikan ke Konsol ApsaraVideo Live > Studio Produksi > Studio Produksi Cloud untuk melihat nama studio produksi. Catatan Nama studio produksi dalam daftar studio produksi pada halaman Studio Produksi Cloud di Konsol ApsaraVideo Live adalah ID studio produksi. Studio produksi harus memenuhi konfigurasi berikut: NormType: 3. Buat studio produksi carousel ringan terlebih dahulu. Anda dapat memanggil operasi CreateCaster untuk membuat studio produksi. CasterTemplate: lp_noTranscode. channelEnable: 0. programEffect: 1.	0e94d1f4-1a65-445c-9dcf-de8b3b8d****
ProgramItems	string	Yes	Daftar input item daftar putar. Nilainya adalah string JSON. Untuk informasi lebih lanjut, lihat InputProgramItem.	[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f**"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c**"}]
ProgramId	string	No	ID daftar putar. Jika studio produksi sudah memiliki daftar putar, Anda harus menentukan ProgramId yang sesuai. Jika belum ada daftar putar yang dibuat, Anda dapat mengosongkan parameter ini, dan sistem akan melakukan pembuatan otomatis.	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramConfig	string	No	Konfigurasi item daftar putar. Jika ini adalah pertama kali Anda menambahkan item daftar putar, tentukan parameter ini untuk inisialisasi pengatur waktu. Untuk informasi lebih lanjut, lihat ProgramConfig.	[{"RepeatNumber":"0","ProgramName":"my program"}]

InputProgramItem

Parameter	Contoh	Tipe	Deskripsi
ItemName	item1	String	Nama item daftar putar.
ResourceType	vod	String	Tipe resource. Nilai valid: vod: Resource ApsaraVideo VOD. url: Resource video pihak ketiga.
ResourceValue	5f8809f2-3352-4d1f-a8f7-86f9429f****	String	Jika ResourceType diatur ke vod, ResourceValue adalah ID aset media. Jika ResourceType diatur ke url, ResourceValue adalah URL video pihak ketiga.

ProgramConfig

Parameter	Contoh	Tipe	Deskripsi
RepeatNumber	0	Integer	Jumlah kali pemutaran diulang setelah daftar putar selesai. Nilai valid: 0 (default): tidak ada pemutaran ulang. -1: loop tanpa batas. Bilangan bulat positif lainnya: jumlah kali pemutaran diulang setelah daftar putar selesai.
ProgramName	myprogram	String	Nama daftar putar.

Elemen respons

Element	Type	Description	Example
	object
Items	object	Daftar item daftar putar yang ditambahkan.
FailedItems	array<object>	Daftar item daftar putar yang gagal ditambahkan.
	object
ItemId	string	ID item playlist.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	Nama item playlist.	item1
SuccessItems	array<object>	Daftar item daftar putar yang berhasil ditambahkan.
	object
ItemId	string	ID item playlist.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	Nama item playlist.	item2
ProgramId	string	ID daftar putar. Nilai ini dapat digunakan sebagai parameter permintaan untuk menghapus item daftar putar, mengkueri item daftar putar, mengedit daftar putar, menghapus daftar putar, mengkueri daftar putar, memulai daftar putar, dan menghentikan daftar putar.	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	ID permintaan.	5c6a2a0d-f228-4a64-af62-20e91b96****

Contoh

Respons sukses

JSONformat

{
  "Items": {
    "FailedItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item1"
      }
    ],
    "SuccessItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item2"
      }
    ]
  },
  "ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidCasterId.Malformed	%s, please check and try again later.	Parameter CasterId tidak valid. Periksa parameter dan coba lagi.
400	PlayListIsEmpty	%s, please check and try again later.	Daftar putar kosong. Periksa daftar putar lalu coba lagi.
400	MissInputParams	%s, please check and try again later.	Parameter yang diperlukan tidak ada. Periksa dan coba lagi.
400	InvalidProgramId.Malformed	%s, please check and try again later.	Parameter ProgramId tidak valid. Periksa parameter lalu coba lagi.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	Parameter berikut tidak valid: %s.
500	InternalError	%s, please try again later.	Terjadi error internal. Coba lagi nanti.
403	UserQuotaExceed	Quota exceeded: %s.	Kuota telah terlampaui: %s.
404	InvalidCaster.NotFound	%s, please check and try again later.	Studio produksi tidak ada. Periksa konfigurasi dan coba lagi.
404	InvalidDomainName.NotFound	%s, please check and try again later.	Nama domain tidak ada. Periksa nama domain lalu coba lagi.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.