調用CreateLivePullToPush建立拉流轉推任務-ApsaraVideo for Live-阿里雲 - ApsaraVideo Live

呼叫CreateLivePullToPush建立拉流轉推任務。

介面說明

重要拉流轉推屬於收費功能，於 2025 年 12 月 05 日 00:00 起正式計費。

費用詳情請參見拉流轉推費用。
呼叫本介面建立拉流轉推任務。
支援建立直播拉流任務，也支援建立點播拉流任務。
任務建立後，到了設定的開始時間，會真正開始執行，到了設定的結束時間，會自動停止並刪除清理。
任務中設定的推流目標位址需要確保未被其他任務使用，不然會因為多個任務同時轉推相同位址導致推流失敗。
拉流轉推回呼事件包括拉流轉推任務執行狀態變化回呼和拉流轉推任務已退出回呼。更多資訊，請參見拉流轉推事件回呼。

QPS 限制

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:CreateLivePullToPush

create

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地域 ID。	cn-beijing
Region	string	是	指定任務啟動所在區域，取值： ap-southeast-1（新加坡） ap-southeast-5（印度尼西亞） cn-beijing（北京） cn-shanghai（上海） cn-shenzhen（深圳）枚舉值： cn-shenzhen : 深圳 cn-qingdao : 青島 preregion : 預發 cn-beijing : 北京 cn-shanghai : 上海 ap-southeast-1 : 新加坡 eu-central-1 : 德國-法蘭克福 ap-northeast-1 : 日本-東京 ap-southeast-5 : 印度尼西亞 me-central-1 : 沙特-利雅得	cn-shanghai
TaskName	string	否	任務名稱，用於支援模糊查詢，預設值為""。	test
StartTime	string	是	任務開始時間。說明格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2024-08-26T10:30:00Z
EndTime	string	是	任務結束時間。說明格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。 EndTime 必須大於 StartTime。 EndTime 必須大於當前時間。	2024-08-27T14:30:00Z
SourceType	string	是	來源流類型，列舉值： live，直播流。 vod，阿里雲視訊點播資源。 url，第三方視訊檔案資源。枚舉值： vod : 阿里雲視訊點播資源 live : 直播流 url : 第三方視訊檔案資源	live
SourceProtocol	string	否	來源流協議名。取值範圍 rtmp srt http-flv hls 說明此參數僅當sourcetype 參數取值為 live 時必填，取值為 vod、url 時無效。	rtmp
SourceUrls	array	是	來源流 URL 位址列表。說明 live 類型僅支援填寫 1 個完整直播播放 URL。 vod、url 類型可填寫最多 30 個。 live 類型支援：rtmp、srt、http-flv 協議。 vod 類型填寫阿里雲視訊點播媒資 ID。 url 類型支援：mp4、http-flv 協議。
	string	否	來源流 URL 位址。說明 live 類型僅支援填寫 1 個完整直播播放 URL。 vod、url 類型可填寫最多 30 個。 live 類型支援：rtmp、srt、http-flv 協議。 vod 類型填寫阿里雲視訊點播媒資 ID。 url 類型支援：mp4、http-flv 協議。	rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434
DstUrl	string	是	推流目標 URL 位址。說明支援 rtmp 協議。最大長度為 2000 個字元。	rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434
RepeatNumber	integer	否	播放完後重複繼續播放的次數。取值： 0（預設值）：不重複播放。 -1：一直循環重複。其他正整數：播放完後重複繼續播放的次數。說明此參數僅針對點播或第三方視訊流。	0
FileIndex	integer	否	檔案索引，從第 n 個檔案開始播放起。	0
Offset	integer	否	啟動偏移，視訊檔案起始偏移值。單位：秒。取值：大於 0。說明表示從相對於首幀的偏差時間作為開始讀取的位置（指第一個視訊）。此參數僅針對點播或第三方視訊流。	2
CallbackUrl	string	否	HTTP 回呼位址，預設為空。說明接收任務相關回呼的位址。最大長度為 2000 個字元。不指定本參數則不會回呼相關任務事件。	https://callback*****.com
RetryInterval	integer	否	重試間隔，單位秒，取值區間[60,300]，預設 60 秒。	60
RetryCount	integer	否	重試次數，預設值為 3。	3

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	16A96B9A-F203-4EC5-8E43-CB92E68*****
RetCode	integer	回傳碼。說明正常情況回傳"0"。異常情況請參考下文錯誤碼列表。	0
Description	string	錯誤描述。	OK
TaskId	string	任務 ID。	fd245384-4067-4f91-9d75-9666a6bc9****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68*****",
  "RetCode": 0,
  "Description": "OK",
  "TaskId": "fd245384-4067-4f91-9d75-9666a6bc9****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidParameter	%s.
400	InvalidParam.CodeIllegalDuration	%s.
400	CodeInvalidAliUid	This aliuid does not have a live domain name.
400	CodeNotEnoughResource	Exceeded configuration limits or insufficient resources.
400	CodeConfigAlreadyExists	Code Config Already Exists
500	InternalError	%s.

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

變更歷史

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