調用DescribeLiveStreamWatermarkRules查詢浮水印規則列表。
介面說明
本介面支援指定分⻚參數查詢浮水印規則列表資訊,調用時請保證參數設定符合要求。
QPS 限制
本介面的單使用者 QPS 限制為 60 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:DescribeLiveStreamWatermarkRules |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-shanghai |
| Domain |
string |
否 |
主播流網域名稱。 |
live.yourdomain.com |
| PageNumber |
integer |
否 |
分⻚的⻚數,不傳預設為 1。 |
1 |
| PageSize |
integer |
否 |
分⻚每⻚個數,不傳預設為 100。 |
100 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| Total |
integer |
合格總個數。 |
100 |
| RequestId |
string |
請求 ID。 |
5c6a2a0df228-4a64- af62-20e91b9676b3 |
| RuleInfoList |
object |
||
| RuleInfo |
array<object> |
⽔印規則列表。 |
|
|
object |
⽔印規則列表。 |
||
| Domain |
string |
播流網域名稱。 |
example.aliyundoc.com |
| Description |
string |
自訂規則描述資訊。 |
my rule |
| App |
string |
播流所屬應用程式名稱。 |
liveApp**** |
| Stream |
string |
流名稱。規則如下:
重要
|
liveStreamA |
| Name |
string |
自訂規則名稱。 |
WatermarkRule**** |
| TemplateId |
string |
浮水印模板 ID。 說明
可查看 AddLiveStreamWatermark 介面返回參數值擷取 TemplateId。 |
445409ec-7eaa-461d-8f29-4bec2eb9 **** |
| RuleId |
string |
浮水印規則 ID。 說明
可查看 AddLiveStreamWatermarkRule 介面返回參數值擷取 RuleId。 |
445409ec-7eaa-461d -8f29-4bec2eb9**** |
樣本
正常返回樣本
JSON格式
{
"Total": 100,
"RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
"RuleInfoList": {
"RuleInfo": [
{
"Domain": "example.aliyundoc.com",
"Description": "my rule",
"App": "liveApp****",
"Stream": "liveStreamA",
"Name": "WatermarkRule****",
"TemplateId": "445409ec-7eaa-461d-8f29-4bec2eb9 ****",
"RuleId": "445409ec-7eaa-461d -8f29-4bec2eb9****"
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameters | %s Please check and try again later. | 存在異常參數,請檢查後重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。