RegisterMedia - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Deskripsi operasi

Untuk memproses file audio dan video dari bucket OSS menggunakan ApsaraVideo VOD, Anda harus terlebih dahulu mendaftarkannya. Setelah pendaftaran, Anda dapat menggunakan ID media untuk memulai tugas seperti transkoding, pembuatan snapshot, dan pemrosesan AI.
Anda dapat mendaftarkan hingga 10 file media OSS dalam satu panggilan API. Semua file dalam permintaan harus berbagi lokasi penyimpanan yang sama.
File media yang diunggah langsung ke ApsaraVideo VOD akan ditranskoding secara otomatis menggunakan kelompok template default jika tidak ada yang ditentukan. Namun, media yang terdaftar tidak ditranskoding secara otomatis. Untuk memicu transkoding, Anda harus menentukan ID kelompok template transkoding selama pendaftaran.
Mendaftarkan ulang file akan mengembalikan ID media yang sudah ada dan tidak melakukan aksi lain.
Pastikan file media yang ingin Anda daftarkan memiliki ekstensi file yang valid. Jika tidak, pendaftaran akan gagal.

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

create

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegisterMetadatas	string	Yes	Metadata media yang akan didaftarkan. Parameter ini berupa string JSON. Anda dapat menentukan metadata untuk hingga 10 file media. Untuk informasi lebih lanjut mengenai struktur parameter, lihat tabel RegisterMetadata di bawah ini.	[{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"VideoName"}]
TemplateGroupId	string	No	ID kelompok template transkoding. Anda dapat memperoleh ID tersebut dengan salah satu cara berikut: Masuk ke Konsol ApsaraVideo VOD. Di panel navigasi sisi kiri, pilih Manajemen Konfigurasi > Konfigurasi Pemrosesan Media > kelompok template transkoding untuk melihat ID kelompok template transkoding. Panggil operasi AddTranscodeTemplateGroup untuk membuat kelompok template transkoding. Nilai `TranscodeTemplateGroupId` dalam respons adalah ID kelompok template transkoding. Panggil operasi ListTranscodeTemplateGroup untuk mengkueri kelompok template transkoding. Nilai `TranscodeTemplateGroupId` dalam respons adalah ID kelompok template transkoding. Catatan Jika Anda tidak perlu mentranskoding media, tetapkan parameter ini ke VOD_NO_TRANSCODE. Jika tidak, status video akan tetap uploaded, dan media tidak dapat diputar. Jika Anda menentukan `WorkflowId` dan `TemplateGroupId`, `WorkflowId` akan diutamakan. Untuk informasi lebih lanjut, lihat Workflows. Parameter ini memicu Tugas asinkron. Setelah permintaan dikirim, tugas akan masuk antrean untuk pemrosesan latar belakang dan tidak langsung selesai.	ca3a8f6e49c87b65806709586****
UserData	string	No	Pengaturan kustom dalam format string JSON, termasuk konfigurasi untuk callback pesan. Untuk informasi lebih lanjut, lihat UserData. Catatan Operasi ini tidak menghasilkan callback saat pendaftaran. Namun, alamat callback yang ditentukan di UserData digunakan untuk tugas transkoding atau snapshot berikutnya pada media yang terdaftar, kecuali callback berbeda ditentukan untuk tugas tersebut.	{"Extend":{"localId":"****","test":"www"}}
WorkflowId	string	No	ID alur kerja. Anda dapat masuk ke Konsol ApsaraVideo VOD dan memilih Manajemen Konfigurasi > Konfigurasi Pemrosesan Media > Alur Kerja di panel navigasi sisi kiri untuk melihat ID alur kerja. Catatan Jika Anda menentukan `WorkflowId` dan `TemplateGroupId`, `WorkflowId` akan diutamakan. Untuk informasi lebih lanjut, lihat Workflows. Parameter ini memicu Tugas asinkron. Setelah permintaan dikirim, tugas akan masuk antrean untuk pemrosesan latar belakang dan tidak langsung selesai.	637adc2b7ba51a83d841606f8****
EnableFirstFrameCover	boolean	No
GenerateThumbnail	boolean	No

RegisterMetadata

Menentukan metadata untuk media yang ingin Anda daftarkan.

Parameter	Type	Required	Description
FileURL	String	Yes	URL file sumber. Anda dapat memanggil operasi GetMezzanineInfo untuk memperoleh URL tersebut. Panjang URL tidak boleh melebihi 1.024 byte dan nama file harus unik secara global. Jika Anda mendaftarkan file dengan nama yang sama, operasi akan mengembalikan ID media unik yang terkait dengannya. URL terdiri dari endpoint publik bucket OSS yang diikuti oleh nama objek.
Title	String	Yes	Judul media. Panjang judul dapat mencapai 128 byte dan harus dienkode UTF-8.
Description	String	No	Deskripsi media. Panjang deskripsi dapat mencapai 1.024 byte dan harus dienkode UTF-8.
Tags	String	No	Tag media. Anda dapat menentukan hingga 16 tag, dipisahkan dengan koma (,). Setiap tag dapat mencapai 32 byte dan harus dienkode UTF-8.
CoverURL	String	No	URL gambar sampul. Panjang URL tidak boleh melebihi 1.024 byte.
CateId	Long	No	ID kategori. Anda dapat memperoleh ID tersebut dengan salah satu cara berikut: Masuk ke Konsol ApsaraVideo VOD. Di panel navigasi sisi kiri, pilih Manajemen Konfigurasi > Konfigurasi Aset Media > Manajemen Kategori untuk melihat ID kategori. Panggil operasi AddCategory untuk membuat kategori. Nilai `CateId` dalam respons adalah ID kategori. Panggil operasi GetCategories untuk mengkueri kategori. Nilai `CateId` dalam respons adalah ID kategori.
ReferenceId	String	No	ID kustom. ID dapat berisi huruf kecil, huruf besar, angka, tanda hubung (-), dan garis bawah (_). Panjang ID harus 6 hingga 64 karakter dan harus unik dalam akun Anda.

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	14F43C5C-8033-448B-AD04F64E5098****
FailedFileURLs	array	Daftar URL untuk file yang gagal didaftarkan.
	string	Daftar URL untuk file yang gagal didaftarkan.	["http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"]
RegisteredMediaList	array<object>	Daftar semua media yang berhasil diproses dalam permintaan, termasuk file yang baru didaftarkan dan yang sudah terdaftar sebelumnya.
	object	Detail pendaftaran.
NewRegister	boolean	Menunjukkan apakah media baru didaftarkan atau sudah terdaftar. true: Baru didaftarkan. false: Sudah terdaftar.	false
FileURL	string	URL file OSS.	http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4
MediaId	string	ID media. Untuk file audio atau video, ID ini sesuai dengan VideoId.	d97af32828084d1896683b1aa38****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "14F43C5C-8033-448B-AD04F64E5098****",
  "FailedFileURLs": [
    "[\"http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4\"]"
  ],
  "RegisteredMediaList": [
    {
      "NewRegister": false,
      "FileURL": "http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4",
      "MediaId": "d97af32828084d1896683b1aa38****"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.