SetLiveStreamsNotifyUrlConfig - 設定推流回調通知地址配置 - ApsaraVideo Live

介面說明

本介面支援配置推流網域名稱的回調地址及其鑒權資訊。
流狀態即時資訊回調，可以及時通知使用者推流或斷流操作結果。詳細資料，請參見推流回調格式說明。

QPS 限制

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:SetLiveStreamsNotifyUrlConfig

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
DomainName	string	是	您的推流網域名稱。	demo.aliyundoc.com
SwitchNotifyUrl	string	否	切流資訊回調 URL 地址	http://guide.aliyundoc.com/switchnotify
NotifyUrl	string	否	直播流資訊推送到的 URL 地址。	http://guide.aliyundoc.com/notify
ExceptionNotifyUrl	string	否	例外狀況事件回調地址 URL。	https://4a7e5f08.r37.cpolar.top/live/Rsssd/call-back/streamStart
NotifyReqAuth	string	否	是否開啟鑒權。取值： yes：開啟。如果選擇取值為 yes，必須同時佈建要求參數 NotifyAuthKey。 no：不開啟。說明不填預設為 no。鑒權邏輯請參考下文的推流回調鑒權說明。	yes
NotifyAuthKey	string	否	鑒權 key。說明當請求參數 NotifyReqAuth 取值為 yes 時，本參數必填。取值要求： 16~64 個字元。支援大寫字母、小寫字母、數字。	123456

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	40A4F36D-A7CC-473A-88E7-154F92242566

樣本

正常返回樣本

JSON格式

{
  "RequestId": " 40A4F36D-A7CC-473A-88E7-154F92242566"
}

異常返回樣本

JSON格式

{
    "Code":"InternalError",
    "HostId":"live.aliyuncs.com",
    "Message":"The request processing has failed due to some unknown error.",
    "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParam	Parameter invalid.	輸入參數不合法
400	ConfigAlreadyExists	Config has already exist.
400	CodeGetMainPlaybackDomainError	Failed to obtain the main playback domain name.	擷取主播放網域名稱失敗。
400	CodeNotPushDomain	The domain name is not a push domain name.	該網域名稱不是推流網域名稱。
500	InternalError	The request processing has failed due to backend service exception.

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

變更歷史

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