SubmitSnapshotJob - ApsaraVideo VOD

Panggil operasi ini untuk mengirim pekerjaan snapshot video guna diproses secara asinkron.

Deskripsi operasi

Hanya format citra JPG yang didukung.
Setelah pekerjaan snapshot selesai, notifikasi event SnapshotComplete akan dihasilkan. Jenis event-nya adalah EventType=SnapshotComplete dan subtipe-nya adalah SubType=SpecifiedTime.

Batas QPS

Batas permintaan per detik (QPS) untuk satu pengguna pada operasi ini adalah 30 panggilan per detik. Jika batas ini terlampaui, panggilan API akan dikenai pengendalian aliran, yang dapat memengaruhi bisnis Anda. Untuk informasi selengkapnya, 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

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
VideoId	string	No	ID video. Anda dapat memperoleh ID video dengan salah satu cara berikut: Untuk video yang diunggah ke Konsol ApsaraVideo VOD, login ke konsol lalu pilih Media Assets > Audio/Video untuk melihat ID video. Saat Anda memanggil operasi CreateUploadVideo untuk mendapatkan URL unggah dan kredensial, ID video adalah nilai parameter VideoId dalam respons. Setelah video diunggah, Anda dapat memanggil operasi SearchMedia untuk menanyakan ID video. ID video adalah nilai parameter VideoId dalam respons.	d3e680e618708efbf2cae7cc9312****
SpecifiedOffsetTime	integer	No	Waktu mulai snapshot. Unit: milidetik. Nilai default: 0.	0
Width	string	No	Lebar snapshot. Nilai yang valid: `[8,4096]`. Nilai default adalah lebar video sumber. Unit: px.	1280
Height	string	No	Tinggi snapshot. Nilai yang valid: `[8,4096]`. Nilai default adalah tinggi video sumber. Unit: px.	720
Count	integer	No	Jumlah maksimum snapshot. Nilai default: 1.	1
Interval	integer	No	Interval antar snapshot. Nilainya harus lebih besar dari atau sama dengan 0. Unit: detik. Nilai default: 1. Jika Anda mengatur Interval ke 0, snapshot akan diambil pada interval yang sama berdasarkan durasi video dan nilai Count.	1
SpriteSnapshotConfig	string	No	Konfigurasi untuk menghasilkan sprite. Jika Anda menentukan parameter ini, sprite akan 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. Anda dapat membuat templat snapshot dan menentukan ID-nya untuk mengonfigurasi pekerjaan snapshot. Untuk informasi selengkapnya tentang cara membuat templat snapshot, lihat AddVodTemplate. Jika Anda menentukan ID templat snapshot, semua parameter permintaan lainnya kecuali Action dan VideoId akan diabaikan. Jika Anda menentukan ID templat snapshot, parameter templat akan menggantikan parameter permintaan lain yang memiliki nama yang sama.	f5b228fe693bf55bd87b789****
UserData	string	No	Pengaturan kustom. Parameter ini harus berupa string JSON. Parameter ini mendukung transmisi langsung data kustom dan pengaturan alamat webhook. Untuk informasi lebih lanjut tentang struktur parameter, lihat UserData. Catatan Untuk menggunakan fitur callback pesan dalam parameter ini, konfigurasikan alamat webhook HTTP dan pilih jenis event 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	Titik waktu saat Anda ingin mengambil snapshot. Unit: milidetik. Anda dapat menentukan hingga 30 titik waktu.
	integer	No	Titik waktu kustom. Unit: milidetik.	1000
ReferenceId	string	No	ID kustom. ID hanya boleh terdiri atas huruf kecil, huruf kapital, angka, tanda hubung (-), dan garis bawah (_). Panjang ID harus antara 6 hingga 64 karakter. ID harus unik untuk setiap pengguna.	123-123

Catatan

Tentukan minimal salah satu dari parameter Count dan Interval. Jika kedua parameter tersebut ditentukan, parameter yang menghasilkan jumlah snapshot lebih sedikit akan diprioritaskan.

Elemen respons

Element	Type	Description	Example
	object	Respons.
RequestId	string	ID permintaan.	25818875-5F78-5EB0-4AF6-D7393642****
SnapshotJob	object	Informasi mengenai 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.