All Products
Search

This Product

    ApsaraVideo VOD:RegisterMedia

    Document Center

    ApsaraVideo VOD:RegisterMedia

    Last Updated:Jul 21, 2026

    Mendaftarkan aset media. File media yang sudah ada dan disimpan di bucket OSS Anda sendiri yang terhubung ke ApsaraVideo VOD harus didaftarkan untuk menghasilkan data terkait yang diperlukan oleh VOD sebelum Anda dapat menggunakan fitur VOD seperti transkoding dan pengambilan snapshot.

    Deskripsi operasi

    • Untuk file audio dan video yang sudah disimpan di bucket OSS yang terhubung ke ApsaraVideo VOD, Anda harus memanggil operasi ini untuk menghasilkan data terkait yang diperlukan oleh VOD sebelum Anda dapat memulai transkoding, pengambilan snapshot, pemrosesan AI, dan operasi lainnya pada file-file tersebut melalui ID media.

    • Anda dapat mendaftarkan hingga 10 file media OSS sekaligus, dan semua file media yang dikirimkan dalam satu permintaan harus sesuai dengan alamat penyimpanan yang sama.

    • Untuk file media yang diunggah melalui VOD, jika tidak ada ID kelompok template transkoding yang ditentukan, kelompok template default akan digunakan untuk transkoding. Sebaliknya, setelah pendaftaran aset media, transkoding tidak otomatis dipicu jika tidak ada ID kelompok template transkoding yang ditentukan. Jika ID kelompok template transkoding ditentukan, transkoding dilakukan berdasarkan kelompok template yang ditentukan.

    • Jika file media didaftarkan berulang kali, hanya ID media unik yang terkait dengannya yang dikembalikan, dan tidak ada pemrosesan lain yang dilakukan.

    • Pastikan file media yang ingin Anda daftarkan memiliki ekstensi nama 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

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegisterMetadatas

    string

    Yes

    Metadata aset media yang akan didaftarkan. Nilainya adalah string JSON. Anda dapat menentukan metadata untuk hingga 10 aset media sekaligus. Untuk informasi lebih lanjut tentang struktur parameter, lihat tabel RegisterMetadata di bawah ini.

    [{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"NamaVideo"}]
    TemplateGroupId

    string

    No

    ID kelompok template transkoding. Anda dapat memperoleh ID tersebut dengan salah satu metode berikut:

    • Masuk ke Konsol ApsaraVideo VOD dan pilih Manajemen Konfigurasi > Pemrosesan Media > Kelompok Template Transkoding untuk melihat ID kelompok template transkoding.

    • Dapatkan nilai TranscodeTemplateGroupId dari tanggapan saat Anda memanggil operasi CreateTranscodeTemplateGroup.

    • Dapatkan nilai TranscodeTemplateGroupId dari tanggapan saat Anda memanggil operasi ListTranscodeTemplateGroup.

    Catatan

    • Jika transkoding tidak diperlukan, atur parameter ini menjadi VOD_NO_TRANSCODE (kelompok template tanpa transkoding). Jika tidak, status video adalah UploadSucc dan video tidak dapat diputar menggunakan layanan pemutaran. Jika transkoding diperlukan, tentukan ID kelompok template transkoding yang sesuai.

    • Jika WorkflowId dan TemplateGroupId keduanya ditentukan, WorkflowId akan diutamakan. Untuk informasi lebih lanjut, lihat Alur kerja.

    • Parameter ini memicu Tugas asinkron. Setelah pengiriman, tugas masuk ke antrian latar belakang untuk eksekusi asinkron.

    ca3a8f6e49c87b65806709586****
    UserData

    string

    No

    Pengaturan kustom. Nilainya adalah string JSON yang mendukung pengaturan seperti callback Paket. Untuk informasi lebih lanjut, lihat UserData.

    Catatan

    Operasi ini tidak mendukung callback. Meskipun Anda mengonfigurasi callback Paket dalam parameter ini, tidak ada pesan callback yang dihasilkan setelah pendaftaran aset media selesai. Saat Anda kemudian memulai pemrosesan media seperti transkoding atau pengambilan snapshot pada aset media yang terdaftar, jika Anda menentukan callback Paket dalam UserData pada saat itu, URL callback tersebut akan diutamakan. Jika tidak, URL callback yang ditentukan dalam UserData selama pendaftaran aset media akan digunakan.

    {"Extend":{"localId":"****","test":"www"}}
    WorkflowId

    string

    No

    ID alur kerja. Masuk ke Konsol ApsaraVideo VOD dan pilih Manajemen Konfigurasi > Pemrosesan Media > Manajemen Alur Kerja untuk melihat ID alur kerja.

    Catatan

    • Jika WorkflowId dan TemplateGroupId keduanya ditentukan, WorkflowId akan diutamakan. Untuk informasi lebih lanjut, lihat Alur kerja.

    • Parameter ini memicu Tugas asinkron. Setelah pengiriman, tugas masuk ke antrian latar belakang untuk eksekusi asinkron.

    637adc2b7ba51a83d841606f8****
    EnableFirstFrameCover

    boolean

    No

    GenerateThumbnail

    boolean

    No

    RegisterMetadata

    Menentukan metadata aset media yang akan didaftarkan.

    NameTypeRequiredDescription
    FileURLStringYesURL file sumber. Anda dapat memperoleh nilai ini dengan memanggil operasi GetMezzanineInfo.
    URL tidak boleh melebihi 1024 byte. Nama file harus unik secara global. Jika Anda menambahkan file dengan nama yang sama, file tersebut akan dikaitkan dengan ID media unik. URL berada dalam format endpoint publik bucket OSS + ObjectName (nama file).

    TitleStringYesJudul. Judul tidak boleh melebihi 128 byte. Dikodekan UTF-8.
    DescriptionStringNoDeskripsi. Deskripsi tidak boleh melebihi 1024 byte. Dikodekan UTF-8.
    TagsStringNoTag. Setiap tag tidak boleh melebihi 32 byte. Anda dapat menentukan hingga 16 tag. Pisahkan beberapa tag dengan koma (,). Dikodekan UTF-8.
    CoverURLStringNoURL sampul. URL tidak boleh melebihi 1024 byte.
    CateIdLongNoID kategori. Anda dapat memperoleh ID tersebut dengan salah satu metode berikut:
    Masuk ke Konsol ApsaraVideo VOD dan pilih Manajemen Konfigurasi > Manajemen Aset Media > Manajemen Kategori untuk melihat ID kategori.
    Dapatkan nilai CateId dari tanggapan saat Anda memanggil operasi AddCategory.
    Dapatkan nilai CateId dari tanggapan saat Anda memanggil operasi GetCategories.







    ReferenceIdStringNoID kustom. Hanya huruf kecil, huruf besar, angka, tanda hubung (-), dan garis bawah (_) yang didukung. Nilai harus memiliki panjang 6 hingga 64 karakter dan harus unik untuk setiap pengguna.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter tanggapan.

    RequestId

    string

    ID permintaan.

    14F43C5C-8033-448B-AD04F64E5098****
    FailedFileURLs

    array

    Daftar URL file yang gagal didaftarkan.

    string

    Daftar URL file yang gagal didaftarkan.

    ["http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"]
    RegisteredMediaList

    array<object>

    Daftar aset media yang berhasil didaftarkan, termasuk file yang baru didaftarkan dan file yang sebelumnya sudah didaftarkan.

    object

    Detail pendaftaran.

    NewRegister

    boolean

    Menunjukkan apakah aset media baru didaftarkan atau didaftarkan berulang kali.

    • true: baru didaftarkan.

    • false: didaftarkan berulang kali.

    false.
    FileURL

    string

    URL file OSS.

    http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4
    MediaId

    string

    ID media VOD. Jika file media yang terdaftar adalah file audio atau video, nilai ini sesuai dengan VideoId di ApsaraVideo VOD.

    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.