全部產品
Search
文件中心

ApsaraVideo Live:AddCasterEpisode - 添加導播台節目

更新時間:Apr 21, 2026

添加導播台節目。

介面說明

調用本介面必須提前擷取導播台 ID。導播台 ID 在建立導播台後產生。

  • 如果您通過 CreateCaster 介面建立導播台,請查看 CreateCaster 介面調用返回的參數 CasterId 值。

  • 如果您通過直播控制台建立導播台,請通過直播控制台 > 導播台 > 雲導播台路徑查看導播台名稱。

說明

直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。

QPS 許可權

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

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:AddCasterEpisode

create

*Caster

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

無 無

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

否

地區 id。

cn-shanghai

ComponentId

array

否

組件列表。按照元素順序由下而上排列。

如果您通過 AddCasterComponent 介面添加導播台組件,請查看 AddCasterComponent 介面調用返回的參數 ComponentId 值。

  • 當資源類型為 Component 時,參數有用且必傳。

  • 當資源類型為 Resource 時,參數非必傳,傳入時表示組件與視頻源綁定並同步切換。

說明

N 表示第幾個組件 ID。例如:ComponentId.1表示傳入第一個組件 ID;ComponentId.2表示傳入第 2 個組件 ID。

["a2b8e671-2fe5-4642-a2ec-bf93880e****"]

string

否

組件 ID

21926b36-7dd2-4fde-ae25-51b5bc8e****

CasterId

string

是

導播台 ID。

  • 如果您通過 CreateCaster 介面建立導播台,請查看 CreateCaster 介面調用返回的參數 CasterId 值。

  • 如果您通過直播控制台建立導播台,請通過直播控制台> 導播台 > 雲導播台頁面查看。

說明

直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。

LIVEPRODUCER_POST-cn-0pp1czt****

EpisodeType

string

是

節點類型。 取值:

  • Resource:視頻源。如果選擇 Resource 類型,必須同時佈建要求參數 ResourceId 和 SwitchType。

  • Component:組件。

Resource

EpisodeName

string

否

節目名稱。

episode_1

ResourceId

string

否

視頻源 ID。

重要 當 EpisodeType(節點類型)設為 Resource 時本參數有用且必傳。

如果您通過 AddCasterVideoResource 介面添加導播台視頻源,請查看 AddCasterVideoResourcer 介面調用返回的參數 ResourceId 值。

a2b8e671-2fe5-4642-a2ec-bf93880e****

StartTime

string

是

起始時間。 格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2016-06-29T08:00:00Z

EndTime

string

是

結束時間。 格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2016-06-29T09:10:00Z

SwitchType

string

是

切換策略。取值:

重要 當 EpisodeType(節點類型)設為 Resource 時本參數才有效。

  • TimeFirst:時間優先 。

  • ContentFirst:內容優先。

說明

更多關於視頻源的資訊,請參見添加視頻源。

TimeFirst

返回參數

名稱

類型

描述

樣本值

object

EpisodeId

string

節目 ID。可作為查詢導播台節目單、修改導播台節目、刪除導播台節目的請求參數。

21926b36-7dd2-4fde-ae25-51b5bc8e****

RequestId

string

請求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F****

樣本

正常返回樣本

JSON格式

{
  "EpisodeId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 MissingParameter %s. 參數缺失
400 InvalidParameter.Malformed There are invalid parameters: %s. 存在無效參數:%s。
400 SwitchTypeInvalid.Malformed %s, please check and try again later. 參數SwitchType無效,請檢查後重試。
400 IncorrectStartTime %s, please check and try again later. 參數StartTime無效,請檢查後重試。
400 IncorrectEndTime %s, please check and try again later. 參數EndTime無效,請檢查後重試。
400 EpisodeConflict.Malformed %s, please check and try again later. 節目時間存在衝突,請檢查後重試。
400 InvalidCasterId.Malformed %s, please check and try again later. 參數CasterId無效,請檢查後重試。
401 IllegalOperation %s, please check and try again later. 不允許的操作,請檢查後重試。
500 InternalError %s, please try again later. 內部錯誤,請稍後重試。
404 InvalidCaster.NotFound %s, please check and try again later. 導播台不存在,請檢查後重試。
404 InvalidResource.NotFound %s, please check and try again later. 資源不存在,請檢查後重試。
404 InvalidComponent.NotFound %s, please check and try again later. 待操作的組件不存在,請檢查後重試。

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

變更歷史

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