Mengirimkan tugas refresh atau prefetch berdasarkan ID media.
Deskripsi operasi
ApsaraVideo VOD memungkinkan Anda melakukan purge dan prefetch resource. Fitur purge memaksa titik kehadiran (POP) untuk menghapus resource yang di-cache dan mengambil resource terbaru dari origin server. Fitur prefetch memungkinkan POP mengambil resource yang sering diakses dari origin server selama jam sepi, sehingga meningkatkan rasio hit cache.
Anda dapat memanggil operasi ini untuk mengirimkan tugas purge atau prefetch berdasarkan ID media, serta menentukan format dan resolusi aliran media yang akan di-purge atau di-prefetch sesuai kebutuhan bisnis Anda.
Anda dapat mengirimkan hingga 20 tugas purge atau prefetch dalam satu permintaan.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
vod:RefreshMediaPlayUrls |
update |
*All Resource
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| MediaIds |
string |
Yes |
ID file media yang ingin Anda refresh atau prefetch. Anda dapat menentukan maksimal 20 ID. Pisahkan beberapa ID dengan koma (,). Anda dapat menggunakan salah satu metode berikut untuk mendapatkan ID tersebut:
|
ca3a8f6e4957b658067095869****, a6e49sfgd23p5g9ja7095863**** |
| TaskType |
string |
Yes |
Jenis tugas yang ingin Anda buat. Nilai yang valid:
|
Preload |
| Formats |
string |
No |
Format aliran media yang ingin Anda refresh atau prefetch. Anda dapat menentukan beberapa format. Pisahkan beberapa format dengan koma (,). Jika Anda tidak mengisi parameter ini, aliran media dalam semua format akan direfresh atau diprefetch secara default. Nilai yang valid:
|
mp4,m3u8 |
| Definitions |
string |
No |
Menentukan resolusi aliran media yang ingin Anda refresh atau prefetch. Anda dapat menentukan beberapa resolusi. Pisahkan beberapa resolusi dengan koma (,). Jika Anda tidak mengisi parameter ini, aliran media dalam semua resolusi akan direfresh atau diprefetch secara default. Catatan
Nilai tersebut harus didukung di bagian Definition dalam Parameters for media assets. |
HD, SD |
| StreamType |
string |
No |
Menentukan jenis aliran media yang ingin Anda refresh atau prefetch. Anda dapat menentukan beberapa jenis. Pisahkan beberapa jenis dengan koma (,). Jika Anda tidak mengisi parameter ini, aliran media dalam semua jenis akan direfresh atau diprefetch secara default. Nilai yang valid:
|
video |
| ResultType |
string |
No |
Menentukan jenis operasi refresh atau prefetch. Nilai default: Single. Nilai yang valid:
|
Single |
| SliceFlag |
boolean |
No |
Menentukan apakah URL pemutaran file TS dari aliran media M3U8 akan direfresh atau diprefetch. Nilai default: false. Nilai yang valid:
|
false |
| SliceCount |
integer |
No |
Menentukan jumlah URL pemutaran file TS untuk aliran media M3U8 yang ingin Anda refresh atau prefetch. Setelah Anda mengatur parameter ini, hanya URL pemutaran N file TS pertama yang akan direfresh atau diprefetch. Nilai yang valid: 1 hingga 20. Nilai default: 5. |
5 |
| UserData |
string |
No |
Konfigurasi kustom seperti konfigurasi callback dan konfigurasi akselerasi unggah. Nilainya harus berupa string JSON. Untuk informasi selengkapnya, lihat bagian "UserData: menentukan konfigurasi kustom untuk unggah media" dalam topik Request parameter. Catatan
|
{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}} |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Data yang dikembalikan. |
||
| MediaRefreshJobId |
string |
ID tugas refresh atau prefetch. |
41d465e31957**** |
| NonExistMediaIds |
string |
ID file media yang tidak ada. |
ca3a8f6e4957b658067095869**** |
| ForbiddenMediaIds |
string |
ID file media yang tidak dapat dioperasikan. Umumnya, file media tidak dapat dioperasikan karena Anda tidak memiliki otorisasi untuk melakukan operasi tersebut. Untuk informasi selengkapnya, lihat Overview. |
a6e49sfgd23p5g9ja7095863**** |
| RequestId |
string |
ID permintaan. |
25818875-5F78-4AF6-04D5-D7393642**** |
Contoh
Respons sukses
JSONformat
{
"MediaRefreshJobId": "41d465e31957****",
"NonExistMediaIds": "ca3a8f6e4957b658067095869****",
"ForbiddenMediaIds": "a6e49sfgd23p5g9ja7095863****",
"RequestId": "25818875-5F78-4AF6-04D5-D7393642****"
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.