DescribeLiveStreamWatermarks - ApsaraVideo Live

Anda dapat memanggil operasi DescribeLiveStreamWatermarks untuk mengkueri daftar templat watermark.

Deskripsi operasi

Operasi ini mendukung penomoran halaman. Anda dapat mengonfigurasi parameter sesuai kebutuhan.

Batas QPS

Batas permintaan per detik (QPS) untuk satu pengguna adalah 60 panggilan per detik. Jika batas tersebut dilampaui, panggilan API akan dikenai pengendalian aliran (throttled), yang dapat memengaruhi bisnis Anda. Oleh karena itu, panggil operasi ini dengan laju yang wajar.

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

live:DescribeLiveStreamWatermarks

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-shanghai
Domain	string	No	Domain streaming.	live.yourdomain.com
KeyWord	string	No	Kata kunci untuk pencarian. Anda dapat menentukan ID templat atau nama. Pencarian fuzzy didukung untuk nama.	445409ec-7eaa-461d-8f29-4bec2eb9****
PageNumber	integer	No	Nomor halaman. Nilai default adalah 1.	1
PageSize	integer	No	Jumlah templat yang dikembalikan pada setiap halaman. Nilai default adalah 100.	100

Elemen respons

Element	Type	Description	Example
	object	Informasi templat watermark.
Total	integer	Jumlah total entri yang cocok.	100
RequestId	string	ID permintaan.	5c6a2a0df228-4a64- af62-20e91b9676b3
WatermarkList	object
Watermark	array<object>	Daftar templat watermark.
	object	Daftar templat watermark.
Type	integer	Tipe watermark. 0: Citra. Hanya watermark berbasis citra yang didukung. 1: Teks.	0
XOffset	number	Offset sumbu-x watermark dalam piksel (px). Catatan Offset ini relatif terhadap lebar latar belakang referensi (RefWidth). Jika Anda mengatur OffsetCorner ke TopLeft, XOffset menentukan jarak horizontal dari pojok kiri atas video latar belakang ke pojok kiri atas citra watermark. Arah positif sumbu-x mengarah ke kanan.	50.0
RefWidth	integer	Lebar video latar belakang referensi, dalam piksel (px).	1920
YOffset	number	Offset sumbu-y watermark dalam piksel (px). Catatan Offset ini relatif terhadap tinggi latar belakang referensi (RefHeight). Jika Anda mengatur OffsetCorner ke TopLeft, YOffset menentukan jarak vertikal dari pojok kiri atas video latar belakang ke pojok kiri atas citra watermark. Arah positif sumbu-y mengarah ke bawah.	100.0
Height	integer	Tinggi citra watermark, dalam piksel (px).	200
RefHeight	integer	Tinggi video latar belakang referensi, dalam piksel (px).	1080
PictureUrl	string	URL citra watermark.	http://example.com
Transparency	integer	Transparansi watermark. Nilai yang lebih kecil menunjukkan transparansi yang lebih tinggi. Nilai valid: 0 hingga 255.	255
Description	string	Deskripsi kustom watermark.	my watermark
OffsetCorner	string	Posisi watermark. TopLeft: pojok kiri atas TopRight: pojok kanan atas BottomLeft: pojok kiri bawah BottomRight: pojok kanan bawah	TopRight
RuleCount	integer	Jumlah aturan watermark yang dikonfigurasi untuk domain tersebut.	12
Name	string	Nama watermark.	livewatermark****
TemplateId	string	ID templat watermark.	445409ec-7eaa-4 61d-8f29-4bec2eb9 ****

Contoh

Respons sukses

JSONformat

{
  "Total": 100,
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
  "WatermarkList": {
    "Watermark": [
      {
        "Type": 0,
        "XOffset": 50,
        "RefWidth": 1920,
        "YOffset": 100,
        "Height": 200,
        "RefHeight": 1080,
        "PictureUrl": "http://example.com",
        "Transparency": 255,
        "Description": "my watermark",
        "OffsetCorner": "TopRight",
        "RuleCount": 12,
        "Name": "livewatermark****",
        "TemplateId": "445409ec-7eaa-4 61d-8f29-4bec2eb9 ****"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidParameters	%s Please check and try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.