All Products
Search

This Product

    ApsaraVideo VOD:SubmitSnapshotJob

    Document Center

    ApsaraVideo VOD:SubmitSnapshotJob

    Last Updated:Jul 21, 2026

    Mengirimkan Pekerjaan tangkapan video untuk memulai pemrosesan snapshot asinkron.

    Deskripsi operasi

    • Ini adalah operasi asinkron. Setelah Anda mengirimkan tugas, ID tugas dikembalikan (tugas belum selesai dan masuk ke antrian untuk eksekusi asinkron). Hasil akhir dikirim melalui notifikasi callback. Anda juga dapat secara proaktif mengkueri status tugas dengan memanggil GetMediaSnapshotJob.

    • Hanya image JPG yang didukung.

    • Ketika snapshot selesai, notifikasi event Video snapshot complete dengan EventType=SnapshotComplete dan SubType=SpecifiedTime dikirim.

    Batas QPS

    Batas QPS untuk satu pengguna pada operasi ini adalah 30 panggilan per detik. Jika batas ini terlampaui, panggilan API akan dibatasi (throttled), yang dapat memengaruhi bisnis Anda. Panggil operasi ini dengan tepat. Untuk informasi lebih lanjut, lihat Batas QPS.

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

    create

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    VideoId

    string

    No

    ID video. Anda dapat memperoleh ID video dengan menggunakan salah satu metode berikut:

    • Untuk video yang diunggah melalui konsol, masuk ke Konsol ApsaraVideo VOD dan pilih Media Files > Audio/Video untuk melihat ID video.

    • Dapatkan ID video dari nilai parameter respons VideoId saat Anda memanggil operasi CreateUploadVideo untuk memperoleh URL unggah dan kredensial.

    • Setelah video diunggah, panggil operasi SearchMedia untuk mengkueri ID video, yaitu nilai dari parameter respons VideoId.

    d3e680e618708efbf2cae7cc9312****
    SpecifiedOffsetTime

    integer

    No

    Waktu mulai untuk snapshot.

    • Unit: milidetik.

    • Nilai default: 0.

    0
    Width

    string

    No

    Lebar snapshot. Nilai valid: [8,4096]. Nilai default: lebar video sumber. Unit: px.

    1280
    Height

    string

    No

    Tinggi snapshot. Nilai valid: [8,4096]. Nilai default: tinggi video sumber. Unit: px.

    720
    Count

    integer

    No

    Jumlah maksimum snapshot. Nilai default: 1.

    1
    Interval

    integer

    No

    Interval snapshot. Nilainya harus lebih besar dari atau sama dengan 0.

    • Unit: detik.

    • Nilai default: 1.

    • Jika Interval diatur ke 0, snapshot diambil secara merata berdasarkan nilai Count dan durasi video.

    1
    SpriteSnapshotConfig

    string

    No

    Konfigurasi Sprite. Jika parameter ini tidak kosong, Sprite dihasilkan. Untuk informasi lebih lanjut tentang struktur parameter, lihat SpriteSnapshotConfig.

    {'CellWidth': 120, 'CellHeight': 68, 'Columns': 3,'Lines': 10, 'Padding': 20, 'Margin': 50}
    SnapshotTemplateId

    string

    No

    ID templat snapshot.

    • Kami menyarankan Anda membuat templat snapshot terlebih dahulu lalu meneruskan ID templat snapshot. Untuk informasi lebih lanjut tentang cara membuat templat snapshot, lihat Menambahkan templat snapshot.

    • Jika Anda meneruskan ID templat snapshot, semua parameter permintaan kecuali Action dan VideoId diabaikan.

    f5b228fe693bf55bd87b789****
    UserData

    string

    No

    Pengaturan kustom. Hanya string JSON yang didukung. Anda dapat menggunakan parameter ini untuk meneruskan data kustom dan menentukan pengaturan URL callback. Untuk informasi lebih lanjut tentang struktur parameter, lihat UserData.

    Catatan

    Untuk menggunakan callback Paket dalam parameter ini, konfigurasikan URL callback HTTP dan pilih tipe event callback yang sesuai di konsol. Jika tidak, pengaturan callback tidak akan berlaku.

    {"MessageCallback":{"CallbackURL":"http://.example.aliyundoc.com"},"Extend":{"localId":"xxx","example":"www"}}
    SpecifiedOffsetTimes

    array

    No

    Waktu saat snapshot diambil. Unit: milidetik. Anda dapat menentukan hingga 30 waktu sekaligus.

    integer

    No

    Waktu kustom. Unit: milidetik.

    1000
    ReferenceId

    string

    No

    ID kustom. Hanya huruf kecil, huruf besar, digit, tanda hubung, dan garis bawah yang didukung. Panjang: 6 hingga 64 karakter. Nilainya harus unik di tingkat pengguna.

    123-123
    Catatan

    Anda harus menentukan setidaknya satu dari Count dan Interval. Jika keduanya ditentukan, jumlah snapshot yang lebih kecil yang akan berlaku.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    RequestId

    string

    ID permintaan.

    25818875-5F78-5EB0-4AF6-D7393642****
    SnapshotJob

    object

    Informasi pekerjaan snapshot.

    JobId

    string

    ID pekerjaan snapshot.

    ad90a501b1b94b72374ad0050464****

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "25818875-5F78-5EB0-4AF6-D7393642****",
  "SnapshotJob": {
    "JobId": "ad90a501b1b94b72374ad0050464****"
  }
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.