UploadMediaByURL - ApsaraVideo VOD

Deskripsi operasi

Sebelum menggunakan operasi ini, pastikan Anda memahami sepenuhnya metode penagihan dan harga ApsaraVideo VOD. Mengunggah file media ke ApsaraVideo VOD dikenai biaya penyimpanan. Untuk informasi selengkapnya tentang penagihan, lihat Penagihan penyimpanan aset media. Jika Anda telah mengaktifkan akselerasi transfer, biaya akselerasi unggah juga dikenakan saat Anda mengunggah file media ke ApsaraVideo VOD. Untuk informasi selengkapnya tentang penagihan, lihat Penagihan penyimpanan dan akselerasi transfer.
Untuk informasi tentang format file media yang didukung oleh operasi ini, lihat Format media.
Operasi ini cocok untuk skenario di mana file tidak disimpan di server lokal atau terminal dan harus diunggah dari URL yang dapat diakses melalui jaringan publik.
Ini adalah operasi asinkron. Operasi ini tidak dilakukan secara real time, dan ketepatan waktu tidak dijamin. Setelah tugas dikirim, unggahan mungkin memerlukan beberapa jam bahkan berhari-hari untuk selesai. Jika Anda memiliki persyaratan tinggi terhadap ketepatan waktu, gunakan SDK unggah.
Jika callback dikonfigurasi, Anda akan menerima notifikasi event URLUploadComplete setelah unggahan selesai. Anda dapat memanggil operasi GetURLUploadInfos untuk menanyakan status unggahan.
Setelah Anda mengirim tugas unggah, sebuah tugas asinkron dibuat di cloud. Semua tugas unggah URL yang dikirim pengguna di wilayah tersebut masuk ke dalam antrian untuk dieksekusi. Waktu penyelesaian bergantung pada jumlah tugas yang sedang berjalan. Setelah unggahan selesai, Anda dapat menggunakan URL dan ID video dari notifikasi event (message callback) untuk mengaitkan aset media tersebut.
Operasi ini hanya tersedia di wilayah China (Shanghai), China (Beijing), China (Shenzhen), Singapore, dan US (Silicon Valley).
Setiap kali Anda mengirim tugas unggah untuk URL file media yang sama, sebuah aset media baru dengan ID media baru akan dihasilkan di ApsaraVideo VOD.
Jika satu file berukuran lebih dari 20 GB, unggahan akan gagal. Untuk mengunggah file yang lebih besar dari 20 GB, gunakan SDK unggah. Untuk informasi selengkapnya, lihat Ikhtisar SDK unggah.

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

vod:UploadMediaByURL

create

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
UploadURLs	string	Yes	URL file media sumber. URL harus menyertakan ekstensi nama file, seperti mp4 pada `https://**.mp4`. Jika URL tidak menyertakan ekstensi nama file, Anda dapat menentukan ekstensi tersebut dengan mengatur `FileExtension` di dalam `UploadMetadatas`. Jika URL sudah menyertakan ekstensi nama file dan Anda juga mengatur `FileExtension`, nilai `FileExtension` akan diutamakan. Untuk informasi tentang ekstensi nama file yang didukung, lihat Ikhtisar unggahan. Catatan Pisahkan beberapa URL dengan koma (,). Anda dapat menentukan hingga 20 URL. Untuk mencegah kegagalan unggahan akibat karakter khusus, URL-encode** setiap URL sebelum menggabungkannya dengan koma.	https://****.mp4
TemplateGroupId	string	No	ID kelompok template transkoding. Anda dapat memperoleh ID tersebut dengan salah satu cara berikut: Login ke Konsol ApsaraVideo VOD. Pilih Configuration Management > Media Processing > Transcoding Template Groups untuk melihat ID tersebut. Saat Anda memanggil operasi AddTranscodeTemplateGroup untuk membuat kelompok template transkoding, nilai parameter TranscodeTemplateGroupId dalam respons merupakan ID kelompok template transkoding. Saat Anda memanggil operasi ListTranscodeTemplateGroup untuk menanyakan kelompok template transkoding, nilai parameter TranscodeTemplateGroupId dalam respons merupakan ID kelompok template transkoding. Catatan Jika Anda tidak mengatur parameter ini, kelompok template transkoding default akan digunakan. Jika Anda mengatur parameter ini, kelompok template transkoding yang ditentukan akan digunakan. Anda juga dapat mengatur ID kelompok template transkoding di UploadMetadatas. Jika Anda mengatur TemplateGroupId baik di UploadMetadatas maupun di level ini, nilai di dalam `UploadMetadatas` akan diutamakan.	ca3a8f6e4957b65806709586****
StorageLocation	string	No	Alamat penyimpanan file media. Login ke Konsol ApsaraVideo VOD dan pilih Configuration Management > Media Asset Management > Storage untuk melihat alamat penyimpanan. Jika Anda tidak menentukan parameter ini, alamat penyimpanan default akan digunakan.	outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
UploadMetadatas	string	No	Metadata file media yang akan diunggah, dalam bentuk string JSON. Metadata hanya berlaku jika sesuai dengan URL di UploadURLs. Format JSON: `[UploadMetadata, UploadMetadata,…]`. Nilainya harus berupa string JSON. Untuk informasi selengkapnya, lihat tabel UploadMetadata di bawah ini.	[{"SourceURL":"https://example.aliyundoc.com/video01.mp4","Title":"urlUploadTest"}]
UserData	string	No	Pengaturan kustom dalam bentuk string JSON. Anda dapat mengonfigurasi pengaturan seperti callback pesan dan akselerasi transfer. Untuk informasi selengkapnya, lihat UserData. Catatan Untuk menggunakan fitur callback pesan dalam parameter ini, Anda harus mengonfigurasi alamat webhook dan memilih jenis event yang sesuai di Konsol. Jika tidak, pengaturan callback tidak akan berlaku. Untuk informasi tentang cara mengonfigurasi webhook HTTP, lihat Pengaturan callback. Untuk menggunakan fitur akselerasi transfer, Anda harus mengajukan tiket untuk mengaktifkannya. Untuk informasi selengkapnya, lihat Catatan terkait unggahan. Untuk informasi tentang cara mengajukan tiket, lihat Hubungi kami.	{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}
AppId	string	No	ID aplikasi. Nilai default-nya adalah app-1000000. Untuk informasi selengkapnya, lihat Layanan multi-aplikasi.	app-****
WorkflowId	string	No	ID alur kerja. Login ke Konsol ApsaraVideo VOD dan pilih Configuration Management > Media Processing > Workflows untuk melihat ID alur kerja. Catatan Jika Anda menentukan WorkflowId dan TemplateGroupId sekaligus, WorkflowId akan diutamakan. Untuk informasi selengkapnya, lihat Alur kerja.	e1e243b42548248197d6f74f9****
SessionId	string	No	ID deduplikasi kustom. Jika Anda menentukan parameter ini dalam permintaan, sistem akan mengembalikan error jika mendeteksi permintaan dengan ID yang sama dalam 10 menit terakhir. Catatan ID dapat memiliki panjang hingga 50 karakter dan boleh berisi huruf besar, huruf kecil, angka, tanda hubung (-), dan garis bawah (_). Jika Anda tidak menentukan parameter ini atau menentukan string kosong, deduplikasi tidak dilakukan.	5c62d40299034bbaa4c195da330****

UploadMetadata

Name	Type	Required	Description
SourceURL	String	Yes	URL file media sumber yang akan diunggah.
Title	String	No	Judul aset media. Judul dapat memiliki panjang hingga 128 byte dan harus dikodekan dalam UTF-8.
FileSize	String	No	Ukuran file.
Description	String	No	Deskripsi. Deskripsi dapat memiliki panjang hingga 1.024 byte dan harus dikodekan dalam UTF-8.
CoverURL	String	No	URL gambar mini video kustom.
CateId	String	No	ID kategori. Login ke Konsol ApsaraVideo VOD dan pilih Configuration Management > Media Asset Management > Categorization untuk melihat ID kategori.
Tags	String	No	Tag. Satu tag dapat memiliki panjang hingga 32 byte. Anda dapat menentukan maksimal 16 tag. Pisahkan beberapa tag dengan koma (,). Tag harus dikodekan dalam UTF-8.
TemplateGroupId	String	No	ID kelompok template transkoding. Parameter ini menimpa parameter TemplateGroupId luar.
WorkflowId	String	No	ID alur kerja. Jika Anda menentukan WorkflowId dan TemplateGroupId sekaligus, WorkflowId akan diutamakan. Untuk informasi selengkapnya, lihat Alur kerja.
FileExtension	String	No	Ekstensi nama file media. Untuk informasi tentang ekstensi nama file yang didukung, lihat Ikhtisar unggahan.
ReferenceId	String	No	ID kustom. ID dapat memiliki panjang 6 hingga 64 karakter dan boleh berisi huruf kecil, huruf besar, angka, tanda hubung (-), dan garis bawah (_). ID harus unik untuk setiap pengguna.

Catatan

Parameter dalam UploadMetadata, seperti Title, Description, dan Tags, tidak boleh berisi emoji.
Untuk memastikan pemutaran normal, jika Anda mengatur TemplateGroupId ke `VOD_NO_TRANSCODE` untuk mengunggah file video tanpa transkoding, hanya file dalam format MP4, FLV, MP3, M3U8, dan WEBM yang dapat diputar langsung. File dalam format lain hanya dapat disimpan. Perhatikan ekstensi nama file. Jika Anda menggunakan Pemutar Video Apsara, versi pemutar harus 3.1.0 atau lebih baru.
Jika Anda menentukan kelompok template transkoding yang tidak memerlukan transkoding (TemplateGroupId diatur ke `VOD_NO_TRANSCODE`), Anda hanya akan menerima notifikasi event FileUploadComplete setelah video diunggah. Anda tidak akan menerima notifikasi event SingleStreamTranscodeComplete.
Jika callback dikonfigurasi, setelah video diunggah, Anda akan menerima notifikasi event URLUploadComplete selain notifikasi unggahan dan transkoding standar.
Saat Anda mengirim permintaan batch, notifikasi terpisah dikirim untuk setiap SourceURL.

Elemen respons

Element	Type	Description	Example
	object	Respons.
RequestId	string	ID permintaan.	25818875-5F78-4AF6-D7393642CA58****
UploadJobs	array<object>	Daftar pekerjaan unggah.
	object	Detail pekerjaan unggah.
SourceURL	string	URL file sumber dari pekerjaan unggah.	http://example****.mp4
JobId	string	ID pekerjaan unggah.	ad90a501b1b94fb72374ad005046****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "UploadJobs": [
    {
      "SourceURL": "http://example****.mp4",
      "JobId": "ad90a501b1b94fb72374ad005046****"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.