Referensi API DescribeLiveStreamWatermarks - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Mengkueri template watermark.

Deskripsi operasi

This operation supports paging.

QPS limit

You can call this operation up to 60 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

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 utama.	live.yourdomain.com
KeyWord	string	No	Kata kunci untuk pencarian. Anda dapat menentukan ID atau nama template. Pencarian fuzzy didukung untuk nama.	445409ec-7eaa-461d-8f29-4bec2eb9****
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah template yang dikembalikan per halaman. Nilai default: 100.	100

Elemen respons

Element	Type	Description	Example
	object	The watermark template information.
Total	integer	The total number of matching entries.	100
RequestId	string	The request ID.	5c6a2a0df228-4a64- af62-20e91b9676b3
WatermarkList	object
Watermark	array<object>	The list of watermark templates.
	object	The list of watermark templates.
Type	integer	The watermark type. 0: Image. Only image watermarks are supported. 1: Text.	0
XOffset	number	The x-axis offset of the watermark in pixels (px). Catatan The offset is relative to the width of the reference background (RefWidth). If you set OffsetCorner to TopLeft, XOffset specifies the horizontal distance from the top-left corner of the background video to the top-left corner of the watermark image. The positive direction of the x-axis is to the right.	50.0
RefWidth	integer	The width of the reference background video, in pixels (px).	1920
YOffset	number	The y-axis offset of the watermark in pixels (px). Catatan The offset is relative to the height of the reference background (RefHeight). If you set OffsetCorner to TopLeft, YOffset specifies the vertical distance from the top-left corner of the background video to the top-left corner of the watermark image. The positive direction of the y-axis is downward.	100.0
Height	integer	The height of the watermark image, in pixels (px).	200
RefHeight	integer	The height of the reference background video, in pixels (px).	1080
PictureUrl	string	The URL of the watermark image.	http://example.com
Transparency	integer	The transparency of the watermark. A smaller value indicates higher transparency. Valid values: 0 to 255.	255
Description	string	The custom description of the watermark.	my watermark
OffsetCorner	string	The position of the watermark. TopLeft: top-left TopRight: top-right BottomLeft: bottom-left BottomRight: bottom-right	TopRight
RuleCount	integer	The number of watermark rules configured for the domain.	12
Name	string	The name of the watermark.	livewatermark****
TemplateId	string	The ID of the watermark template.	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.