DescribeLiveStreamWatermarks - 查詢浮水印模板列表 - ApsaraVideo Live

調用DescribeLiveStreamWatermarks查詢浮水印模板列表。

介面說明

本介面支援指定分⻚參數查詢浮水印模板列表資訊，調用時請保證參數設定符合要求。

QPS 限制

本介面的單使用者 QPS 限制為 60 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeLiveStreamWatermarks

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-shanghai
Domain	string	否	主播流網域名稱。	live.yourdomain.com
KeyWord	string	否	搜尋關鍵詞。模板 ID 或名稱，名稱支援模糊搜尋。	445409ec-7eaa-461d-8f29-4bec2eb9****
PageNumber	integer	否	分頁的頁數。不傳預設為 1。	1
PageSize	integer	否	每⻚模板數值，不傳預設為 100。	100

返回參數

名稱	類型	描述	樣本值
	object	浮水印模板資訊。
Total	integer	合格總個數。	100
RequestId	string	請求 ID。	5c6a2a0df228-4a64- af62-20e91b9676b3
WatermarkList	object
Watermark	array<object>	浮水印模板列表。
	object	浮水印模板列表。
Type	integer	浮水印類型。 0：圖片（目前只支援圖片）。 1：文字。	0
XOffset	number	⽔印 X 軸位移，單位：px。說明相對於參考背景寬 RefWidth，如果選擇的是 TopLeft，那麼 XOffset 是指⽔印圖⽚的左上⻆和背景視頻的左上⻆的相對位置 X。其中座標指向背景視頻中⼼的⽅向為正⽅向，即 X 軸的正⽅向是向右。	50.0
RefWidth	integer	參考背景視頻寬，單位：px。	1920
YOffset	number	⽔印 Y 軸位移，單位：px。說明相對於參考背景⾼RefHeight，如果選擇的是 TopLeft，那麼 YOffset 是指⽔印圖⽚的左上⻆和背景視頻的左上⻆的相對位置 Y。其中座標指向背景視頻中⼼的⽅向為正⽅向，即 Y 軸的正⽅向是向下。	100.0
Height	integer	浮水印圖片高度，單位：px。	200
RefHeight	integer	參考背景視頻高，單位：px。	1080
PictureUrl	string	浮水印圖片連結。	http://example.com
Transparency	integer	浮水印透明度，數值越小越透明。取值：0~255。	255
Description	string	自訂浮水印描述資訊。	my watermark
OffsetCorner	string	浮水印位置。 TopLeft：左上。 TopRight：右上。 BottomLeft：左下。 BottomRight：右下。	TopRight
RuleCount	integer	Domain 下配置的浮水印規則數量	12
Name	string	浮水印名稱。	livewatermark****
TemplateId	string	浮水印模板 ID。	445409ec-7eaa-4 61d-8f29-4bec2eb9 ****

樣本

正常返回樣本

JSON格式

{
  "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 ****"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParameters	%s

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。