調用AddShowIntoShowList API向雲導播台節目單中添加節目-ApsaraVideo for Live-阿里雲

添加節目到節目單中。

介面說明

請先建立新播單型導播台，添加新播單型導播台視頻資源後再調用本介面添加導播台節目到節目單中。使用 API 建立導播台，請參見建立導播台。

每個節目單最多可添加 1000 個節目。

重要

使用ApsaraVideo for VOD（VOD）資源，可優先選擇託管 Bucket 資源，自有 Bucket 資源存在到期風險，如果您選用自有 Bucket 資源，需注意資源的有效期間時間。
導播台素材資源輸入請優先選擇ApsaraVideo for Live和ApsaraVideo for VOD的資源，若從第三方 URL 輸入資源存在播放失敗可能性，需確定資源的品質和有效性。

QPS 限制

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:AddShowIntoShowList

create

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-shanghai
showList	array<object>	否	需要添加的多個節目資源清單，每個資源都有獨立的 showName，resourceUrl 等參數。
	object	否	導播台列表資訊。
duration	integer	否	單個節目播放時間長度，單位：秒。說明 RepeatTimes 和 Duration 兩者只允許設定其中一個。	20
liveInputType	integer	否	自訂的類型標記。	1
repeatTimes	integer	否	單個節目播放迴圈次數，預設為 0。說明 RepeatTimes 和 Duration 兩者只允許設定其中一個。 RepeatTimes 為重複次數，樣本：0 表示重複 0 次（實際播放 1 次），1 表示重複 1 次（實際播放 2 次），以此類推。	0
resourceId	string	否	點播檔案 ID。	a2b8e671-2fe5-4642-a2ec-bf93880e****
resourceType	string	否	素材類型。取值： live：直播素材。 vod：點播素材。 pic：圖片素材。說明使用ApsaraVideo for VOD（VOD）資源，可優先選擇託管 Bucket 資源，自有 Bucket 資源存在到期風險，如果您選用自有 Bucket 資源，需注意資源的有效期間時間。直播檔案可支援直播素材和第三方 URL。點播檔案可支援點播素材、圖片素材和第三方 URL。	vod
resourceUrl	string	否	播放檔案 URL。	http://**/atestObject**.m3u8
showName	string	否	節目名稱。	liveShow****
CasterId	string	是	導播台 ID。如果您通過 CreateCaster 介面建立導播台，請查看 CreateCaster 介面調用返回的參數 CasterId 值。如果您通過直播控制台建立導播台，請通過直播控制台 > 導播台 > 雲導播台路徑查看導播台名稱。說明直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。	LIVEPRODUCER_POST-cn-0pp1czt****
ShowName	string	否	節目名稱。	liveShow****
ResourceType	string	否	素材類型。取值： live：直播素材。 vod：點播素材。 pic：圖片素材。說明使用ApsaraVideo for VOD（VOD）資源，可優先選擇託管 Bucket 資源，自有 Bucket 資源存在到期風險，如果您選用自有 Bucket 資源，需注意資源的有效期間時間。- 直播檔案可支援直播素材和第三方 URL。- 點播檔案可支援點播素材、圖片素材和第三方 URL。	vod
ResourceUrl	string	否	播放檔案 URL。	http://**/atestObject**.m3u8
ResourceId	string	否	點播檔案 ID。	a2b8e671-2fe5-4642-a2ec-bf93880e****
Duration	integer	否	單個節目播放時間長度，單位：秒。說明 RepeatTimes 和 Duration 兩者只允許設定其中一個。	20
RepeatTimes	integer	否	單個節目播放迴圈次數，預設為 0。說明 RepeatTimes 和 Duration 兩者只允許設定其中一個。- RepeatTimes 為重複次數，樣本：-1 表示可無限重複；0 表示重複 0 次（實際播放 1 次）；1 表示重複 1 次（實際播放 2 次）；以此類推。	0
Spot	integer	否	插入到播放清單的位置。位置從 0 開始，預設添加到當前節目單的末尾。	1
LiveInputType	integer	否	自訂的類型標記。	1
isBatchMode	boolean	否	是否大量新增節目到節目單。取值： true：大量新增。 false：單個添加。說明該參數不填，取值為空白時，也表示單個添加。	false

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	987DA143-A39C-5B5D-AF5B-3B07944A0036
ShowId	string	節目 ID。	a2b8e671-2fe5-4642-a2ec-bf93880e****
failedList	string	添加失敗的資源清單以及失敗原因資訊。	failedList[Show1, Show2...]
successfulShowIds	string	添加成功添加的節目 ID 列表。	f1933f16-5467-4308-b3a9-e8d451a90999，547436b8-c839-4469-a2c0-704c1ce5ce00

樣本

正常返回樣本

JSON格式

{
  "RequestId": "987DA143-A39C-5B5D-AF5B-3B07944A0036",
  "ShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
  "failedList": "failedList[Show1, Show2...]",
  "successfulShowIds": "f1933f16-5467-4308-b3a9-e8d451a90999，547436b8-c839-4469-a2c0-704c1ce5ce00"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidUserId.Malformed	%s
400	InvalidParameter.Malformed	%s
400	InvalidCasterId.Malformed	%s
400	InvalidVodUrl.Malformed	%s
400	MissingParameter	%s
401	IllegalOperation	%s
500	InternalError	%s
404	InvalidCaster.NotFound	%s
404	InvalidShowList.NotFound	%s

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

變更歷史

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