調用AddPlaylistItems為雲導播台添加節目單項-ApsaraVideo for Live-阿里雲 - ApsaraVideo Live

介面說明

先建立導播台，新增導播台版面配置和導播台元件，再呼叫本介面新增節目單項目。若尚未建立過節目單，則直接建立。使用 API 建立導播台請參考建立導播台。

QPS 限制

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:AddPlaylistItems

create

*Caster

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地域 ID。	cn-shanghai
CasterId	string	是	導播台 ID。若您透過 CreateCaster 介面建立導播台，請檢視 CreateCaster 介面呼叫返回的參數 CasterId 值。若您透過直播主控台建立導播台，請透過直播主控台 > 導播台 > 雲端導播台路徑檢視導播台名稱。說明直播主控台雲端導播台頁面導播台清單中的導播台名稱即為導播台 ID。導播台需滿足以下設定： NormType：3。您需要提前建立好輕量級輪播型的導播台，可以呼叫 CreateCaster 介面建立導播台。 CasterTemplate：lp_noTranscode。 channelEnable：0。 programEffect：1。	0e94d1f4-1a65-445c-9dcf-de8b3b8d****
ProgramItems	string	是	節目單項目輸入清單。為 JSON 字串，更多資訊，請參閱 InputProgramItem。	[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f**"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c**"}]
ProgramId	string	否	節目單 ID。若導播台已存在節目單，則必須傳入對應的 ProgramId；若從未建立過節目單，可不填，系統將自動建立。	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramConfig	string	否	節目單項目設定。若首次新增，請傳入此參數進行初始化設定。更多資訊，請參閱 ProgramConfig。	[{"RepeatNumber":"0","ProgramName":"my program"}]

InputProgramItem

參數名稱	範例值	類型	描述
ItemName	item1	String	節目單項目名稱。
ResourceType	vod	String	資源類型。取值： vod：阿里雲影片點播資源。 url：第三方影片資源。
ResourceValue	5f8809f2-3352-4d1f-a8f7-86f9429f****	String	當 ResourceType 為 vod 時，ResourceValue 為媒體資源 ID。當 ResourceType 為 URL 時，ResourceValue 為第三方影片 URL。

ProgramConfig

參數名稱	範例值	類型	描述
RepeatNumber	0	Integer	播放完畢後重複繼續播放的次數。取值： 0（預設值）：不重複播放。 -1：持續循環重複。其他正整數：播放完畢後重複繼續播放的次數。
ProgramName	myprogram	String	節目單名稱。

返回參數

名稱	類型	描述	樣本值
	object
Items	object	新增節目單項目資訊清單。
FailedItems	array<object>	新增失敗的節目單項目清單。
	object
ItemId	string	節目單項 ID。	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	節目單項名稱。	item1
SuccessItems	array<object>	新增成功的節目單項目清單。
	object
ItemId	string	節目單項 ID。	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	節目單項名稱。	item2
ProgramId	string	節目單 ID。可作為刪除節目單項目、查詢節目單項目、編輯節目單、刪除節目單、查詢節目單、啟動節目單、停止節目單的請求參數。	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	請求 ID。	5c6a2a0d-f228-4a64-af62-20e91b96****

樣本

正常返回樣本

JSON格式

{
  "Items": {
    "FailedItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item1"
      }
    ],
    "SuccessItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item2"
      }
    ]
  },
  "ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidCasterId.Malformed	%s, please check and try again later.	參數CasterId無效，請檢查後重試。
400	PlayListIsEmpty	%s, please check and try again later.	播放列表為空，請檢查後重試。
400	MissInputParams	%s, please check and try again later.	參數缺失，請檢查後重試。
400	InvalidProgramId.Malformed	%s, please check and try again later.	參數ProgramId無效，請檢查後重試。
400	InvalidParameter.Malformed	There are invalid parameters: %s.	存在無效參數：%s。
500	InternalError	%s, please try again later.	內部錯誤，請稍後重試。
403	UserQuotaExceed	Quota exceeded: %s.	超出配額：%s。
404	InvalidCaster.NotFound	%s, please check and try again later.	導播台不存在，請檢查後重試。
404	InvalidDomainName.NotFound	%s, please check and try again later.	網域名稱不存在，請檢查後重試。

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

變更歷史

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