All Products
Search
Document Center

ApsaraVideo VOD:Parameter permintaan

Last Updated:Jul 06, 2025

Topik ini menjelaskan parameter permintaan berikut dari operasi API ApsaraVideo VOD: PlayConfig, ReAuthInfo, UserData, SpriteSnapshotConfig, dan EncryptConfig. Topik ini juga menyertakan contoh cara mengonfigurasi parameter tersebut.

PlayConfig: menentukan konfigurasi kustom untuk pemutaran media

Deskripsi

Parameter ini menentukan konfigurasi kustom untuk pemutaran media. Nilainya adalah string JSON. Anda dapat mengonfigurasi pengaturan pemutaran untuk domain streaming tertentu. Tabel berikut menjelaskan bidang dalam PlayConfig.

Bidang

Tipe

Diperlukan

Deskripsi

PlayDomain

String

Tidak

Domain streaming. Jika Anda mengonfigurasi beberapa nama domain asal, Anda dapat menentukan nama domain untuk memutar video. Jika domain streaming yang ditentukan tidak ada, domain streaming default yang dikonfigurasikan untuk alamat penyimpanan video akan dikembalikan di URL streaming. Contoh: "vod.test_domain".

XForwardedFor

String

Tidak

Alamat IP asal klien yang memulai permintaan. Bidang ini digunakan untuk memeriksa apakah permintaan berasal dari alamat IP yang ditambahkan ke grup keamanan peninjauan. Untuk informasi lebih lanjut, lihat Pratinjau alamat IP aman. ApsaraVideo VOD dapat memperoleh alamat IP klien berdasarkan bidang ini setelah permintaan melewati beberapa server proxy. Untuk meningkatkan keamanan data, alamat IP klien dienkripsi menggunakan AES/ECB/PKCS5Padding. Untuk mendapatkan kunci enkripsi, submit a ticket.

Contoh: yqCD7Fp1uqChoVj/sl/p5Q==.

PreviewTime

String

Tidak

Durasi pratinjau. Satuan: detik. Nilai minimum adalah 1. Nilai maksimum adalah durasi total video. Jika Anda mengosongkan bidang ini, seluruh video akan dipratinjau. Untuk informasi lebih lanjut tentang cara mengaktifkan fitur pratinjau, lihat Konfigurasi fitur pratinjau.

MtsHlsUriToken

String

Tidak

MtsHlsUriToken yang dihasilkan oleh layanan penerbitan token. Anda dapat menentukan bidang ini untuk mendekripsi dan memutar video yang dienkripsi menggunakan enkripsi HTTP Live Streaming (HLS). Ini mencegah kunci dekripsi dicuri. Untuk informasi lebih lanjut, lihat Enkripsi HLS.

EncryptType

String

Tidak

Jenis enkripsi. Anda dapat menentukan bidang ini untuk memutar video yang tidak dienkripsi atau video yang dienkripsi dalam jenis tertentu. Nilai valid:

  • Unencrypted: tidak dienkripsi

  • AliyunVoDEncryption: kriptografi eksklusif Alibaba Cloud

  • HLSEncryption: enkripsi HLS

Catatan

Untuk informasi lebih lanjut tentang URL pemutaran aliran terenkripsi, lihat Obtain a playback URL.

StorageClass

String

Tidak

Kelas penyimpanan aset media. Anda dapat menggunakan bidang ini untuk menyaring aliran pemutaran kelas penyimpanan tertentu. Nilai valid:

  • Secara default, bidang ini dibiarkan kosong. String kosong menentukan tidak ada kondisi penyaringan. Jika kelas penyimpanan file audio atau video adalah Standard, URL pemutaran semua aliran akan dikembalikan. Jika kelas penyimpanan sumber daya media bukan Standard, tidak ada URL pemutaran yang dikembalikan. Jika kelas penyimpanan file sumber bukan Standard, hanya URL pemutaran aliran yang telah dikodekan ulang yang dikembalikan, URL pemutaran aliran kualitas asli tidak dikembalikan.

  • All: semua kelas penyimpanan.

  • Standard: Semua sumber daya media disimpan sebagai objek Standard.

  • IA: Semua sumber daya media disimpan sebagai objek IA.

  • Archive: Semua sumber daya media disimpan sebagai objek Archive.

  • ColdArchive: Semua sumber daya media disimpan sebagai objek Penyimpanan Arsip Dingin.

  • SourceIA: Hanya file sumber yang merupakan objek IA.

  • SourceArchive: Hanya file sumber yang merupakan objek Archive.

  • SourceColdArchive: Hanya file sumber yang merupakan objek Penyimpanan Arsip Dingin.

  • Changing: Kelas penyimpanan sumber daya media sedang diubah.

  • SourceChanging: Kelas penyimpanan file sumber sedang diubah.

Contoh kode

PlayConfig={
  "PlayDomain": "vod.test_domain",
  "XForwardedFor": "yqCD7Fp1uqChoVj/sl/p5Q==",
  "PreviewTime": "20",
  "MtsHlsUriToken": "yqCD7Fp1uqChoVjslp5Q",
  "StorageClass": "Standard"
}              

ReAuthInfo: menentukan konfigurasi reotentikasi CDN

Deskripsi

Bidang ini menentukan konfigurasi reotentikasi CDN untuk pemutaran media. Nilainya adalah string JSON. Setelah mengaktifkan fitur reotentikasi CDN, Anda dapat menggunakan bidang ini untuk menentukan bidang uid dan rand untuk penandatanganan URL. Tabel berikut menjelaskan bidang dalam ReAuthInfo.

Bidang

Tipe

Diperlukan

Deskripsi

uid

String

Tidak

Bidang tambahan. Dalam banyak kasus, nilainya diatur ke 0. Anda dapat menentukan nilai kustom untuk bidang ini.

rand

String

Tidak

Nomor acak. Dalam banyak kasus, nilainya diatur ke 0. Untuk menghasilkan URL yang berbeda setiap kali video diminta, Anda dapat menggunakan UUID sebagai nomor acak.

Contoh kode

ReAuthInfo={
  "uid": "12345",
  "rand": "abckljd"
}

UserData: menentukan konfigurasi kustom untuk unggah media

Deskripsi

Bidang ini menentukan konfigurasi kustom untuk unggah media, seperti konfigurasi panggil balik untuk notifikasi peristiwa. Nilainya adalah string JSON.

Tabel berikut menjelaskan bidang dalam UserData.

Bidang

Tipe

Diperlukan

Deskripsi

MessageCallback

String

Tidak

Konfigurasi panggil balik untuk notifikasi peristiwa. Nilainya adalah objek JSON. Jika Anda menentukan bidang ini, konfigurasi panggil balik yang ditentukan akan berlaku. Jika tidak, konfigurasi panggil balik default akan berlaku. Untuk informasi lebih lanjut, lihat Tentukan beberapa URL panggil balik.

Isi berikut menjelaskan parameter:

  • CallbackType: metode panggil balik. Nilai valid: http dan mns.

  • CallbackURL: URL panggil balik HTTP. Parameter ini diperlukan jika Anda mengatur CallbackType ke http.

  • MNSQueueName: nama antrian Layanan Pesan (MNS). Parameter ini diperlukan jika Anda mengatur CallbackType ke mns.

  • MSSEndpoint: titik akhir antrian MNS. Parameter ini diperlukan jika Anda mengatur CallbackType ke mns.

Contoh:

  • Panggil balik HTTP: {"CallbackType":"http", "CallbackURL":"http://callback-host/addr"}

  • Panggil balik MNS: {"CallbackType":"mns","MNSQueueName":"vod-callback-bj","MNSEndpoint":"http://174809843091****.mns.cn-beijing.aliyuncs.com"}

Extend

String

Tidak

Bidang ekstensi kustom, yang ditransmisikan secara transparan selama panggil balik peristiwa. Nilainya bisa mencapai 512 byte panjangnya. Nilainya adalah objek JSON.

Catatan

Kami merekomendasikan Anda mengonversi nilai yang berisi karakter khusus seperti tanda dolar ($), garis miring (/), atau garis miring terbalik (\) menjadi string yang dikodekan Base64.

AccelerateConfig

String

Tidak

Konfigurasi untuk percepatan unggah. Nilainya adalah objek JSON. Contoh: {"Type":"oss","Domain":"https://oss-accelerate.aliyuncs.com"}. Type menentukan metode percepatan dan nilainya hanya bisa oss. Domain menentukan nama domain yang dipercepat. Anda dapat memperoleh nama domain yang dipercepat dari Wilayah dan titik akhir. Secara default, HTTPS digunakan.

Catatan

Anda hanya dapat menggunakan fitur percepatan unggah setelah Anda mengajukan aplikasi untuk mengaktifkan fitur tersebut. Untuk informasi lebih lanjut tentang cara mengaktifkan fitur percepatan unggah dan aturan penagihan fitur tersebut, lihat Percepatan unggah.

Contoh kode

UserData={
  "MessageCallback": {
    "MNSEndpoint":"http://174809843091****.mns.cn-beijing.aliyuncs.com",
    "MNSQueueName":"vod-callback-bj",
    "CallbackType": "mns"
  },
  "Extend": {
    "localId": "xxx",
    "test": "www"
  },
  "AccelerateConfig": {
    "Type": "oss",
    "Domain": "https://oss-accelerate.aliyuncs.com"
  }
}
                        

EncryptConfig: menentukan konfigurasi untuk enkripsi HLS

Bidang ini menentukan konfigurasi untuk enkripsi HLS.

Bidang

Tipe

Diperlukan

Deskripsi

CipherText

String

Ya

Kunci teks sandi yang digunakan untuk memperoleh kunci teks biasa. Atur parameter ini ke nilai CiphertextBlob dalam respons terhadap operasi GenerateKMSDataKey.

DecryptKeyUri

String

Ya

URI kunci yang diperoleh berdasarkan kunci teks sandi. URI terdiri dari alamat IP layanan dekripsi dan nilai Ciphertext.

Layanan dekripsi yang Anda siapkan. Misalnya, jika alamat IP layanan dekripsi Anda adalah http://demo.aliyundoc.com, atur parameter ini ke nilai berikut:

http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt****

KeyServiceType

String

Ya

Jenis layanan kunci. Nilai default: KMS, yang menentukan Key Management Service dari Alibaba Cloud.

SpriteSnapshotConfig: menentukan konfigurasi untuk menangkap sprite gambar

Bidang

Tipe

Diperlukan

Deskripsi

CellWidth

String

Tidak

Lebar snapshot asli yang menyusun sprite gambar. Nilai default: lebar snapshot normal. Satuan: piksel.

CellHeight

String

Tidak

Tinggi snapshot asli yang menyusun sprite gambar. Nilai default: tinggi snapshot normal. Satuan: piksel.

Padding

String

Tidak

Padding snapshot asli yang menyusun sprite gambar. Nilai default: 0. Satuan: piksel.

Margin

String

Tidak

Margin snapshot asli yang menyusun sprite gambar. Nilai default: 0. Satuan: piksel.

Color

String

Tidak

Warna latar belakang sprite gambar. Nilai default: Hitam.

Columns

String

Tidak

Jumlah kolom untuk snapshot asli yang menyusun sprite gambar. Nilai valid: [1,10000]. Nilai default: 10.

Lines

String

Tidak

Jumlah baris untuk snapshot asli yang menyusun sprite gambar. Nilai valid: [1,10000]. Nilai default: 10.

KeepCellPic

String

Tidak

Menentukan apakah akan mempertahankan snapshot asli yang menyusun sprite gambar. Nilai valid:

  • keep

  • delete

Nilai default: keep.

Catatan

Jika ingin menyetel semua bidang dalam SpriteSnapshotConfig ke nilai default yang sesuai, tentukan string JSON kosong untuk SpriteSnapshotConfig.