AddWatermark - ApsaraVideo VOD

Deskripsi operasi

Anda dapat memanggil operasi ini untuk membuat template watermark Image atau template watermark Text. Citra statis dalam format PNG serta citra dinamis dalam format GIF, APNG, dan MOV dapat digunakan sebagai watermark citra.
Setelah membuat template watermark melalui operasi ini, Anda harus memanggil operasi AddTranscodeTemplateGroup atau UpdateTranscodeTemplateGroup untuk mengaitkan template watermark tersebut dengan kelompok template transkoding, sehingga watermark dapat ditambahkan ke video selama proses transkoding.
Untuk informasi selengkapnya, lihat Video watermarks.

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

create

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Type	string	Yes	Jenis template watermark. Nilai yang valid: Image (default): template watermark citra Text: template watermark teks	Text
Name	string	Yes	Nama template watermark. Hanya mendukung huruf dan angka. Nama tidak boleh melebihi 128 byte. Nilai harus dikodekan dalam UTF-8.	watermark
WatermarkConfig	string	Yes	Informasi konfigurasi watermark seperti posisi tampilan dan efek khusus. Nilainya harus berupa string JSON. Parameter konfigurasi untuk watermark citra dan teks berbeda. Untuk informasi lebih lanjut mengenai struktur parameter, lihat WatermarkConfig.	{"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft"}
FileUrl	string	No	URL file watermark. URL harus berupa URL Object Storage Service (OSS) dan tidak boleh berisi informasi yang digunakan untuk Penandatanganan URL. Catatan Parameter ini wajib jika Anda mengatur `Type` ke `Image`. Anda dapat memperoleh URL tersebut dari parameter `FileURL` dalam respons operasi CreateUploadAttachedMedia yang Anda panggil untuk mengunggah citra watermark ke ApsaraVideo VOD.	http://outin-326268***63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345***E7FDEC-6-2.png
AppId	string	No	ID aplikasi. Nilai default: app-1000000. Jika Anda telah mengaktifkan layanan multi-aplikasi, tentukan ID aplikasi tempat template watermark akan ditambahkan. Untuk informasi selengkapnya, lihat Overview.	app-****

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfo	object	Informasi mengenai template watermark.
CreationTime	string	Waktu pembuatan template watermark. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.	2018-11-07T09:05:52Z
Type	string	Jenis template watermark. Image: template watermark citra Text: template watermark teks	Text
IsDefault	string	Menunjukkan apakah template watermark tersebut merupakan template default. Nilai yang valid: Default NotDefault	NotDefault
FileUrl	string	URL file watermark. URL tersebut merupakan URL Object Storage Service (OSS) atau URL Alibaba Cloud CDN. Catatan Parameter ini hanya dikembalikan untuk template watermark citra.	https://outin-3262***9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=&Signature=gmf1eYMoDVg%2BHQCb4UGozBW**
WatermarkConfig	string	Informasi konfigurasi watermark seperti posisi tampilan dan efek khusus. Nilainya berupa string JSON. Parameter konfigurasi untuk watermark citra dan teks berbeda. Untuk informasi lebih lanjut mengenai struktur parameter, lihat WatermarkConfig.	{"FontColor": "Blue","FontSize": 80, "Content": "watermark test" }
Name	string	Nama template watermark.	text watermark test
WatermarkId	string	ID template watermark.	9bcc8bfadb84*****109a2671d0df97

Contoh

Respons sukses

JSONformat

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-07T09:05:52Z",
    "Type": "Text",
    "IsDefault": "NotDefault",
    "FileUrl": "https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
    "WatermarkConfig": "{\"FontColor\": \"Blue\",\"FontSize\": 80, \"Content\": \"watermark test\" }",
    "Name": " text watermark test",
    "WatermarkId": "9bcc8bfadb84*****109a2671d0df97"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.