全部產品
Search
文件中心

ApsaraVideo Live:AddCasterProgram

更新時間:Jul 14, 2026

新增導播台節目單。

介面說明

請先建立導播台,新增導播台影片資源後再呼叫本介面新增導播台節目單。本介面目前僅支援影片來源和元件兩種節點類型。使用 API 建立導播台,請參見建立導播台

QPS 限制

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

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:AddCasterProgram

create

*Caster

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

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

地域 ID。

cn-shanghai

Episode

array<object>

節目單資訊。

object

節目單資訊。

ComponentId

array

元件清單。按照元素順序由下而上排列。

重要 當 Episode.N.EpisodeType 為 Component 時,本參數有效且為必填。

當節點類型為 Resource 時,表示元件與影片來源綁定並同步切換。

[ "a2b8e671-2fe5-4642-a2ec-bf931826****", "a2b8e671-2fe5-4642-a2ec-28374657****"]

string

元件 ID。

a2b8e671-2fe5-4642-a2ec-bf931826****

EndTime

string

結束時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。必填,未填寫時返回 MissingParameter。

2016-06-29T10:02:00Z

EpisodeName

string

節目名稱。

program_name_1

EpisodeType

string

節點類型。

  • Resource:影片來源。如果選擇 Resource 類型,必須同時設定請求參數 Episode.N.ResourceId 和 Episode.N.SwitchType。

  • Component:元件。如果選擇 Component 類型,必須同時設定請求參數 Episode.N.ComponentId.N。

說明
  • 當選擇 Resource 且所引用資源包含 VodUrl(隨選視訊檔案)時,EndTime - StartTime 不能超過該 VOD 檔案的實際播放時長(秒級),否則返回 InvalidParameter.EndTime。

Resource

ResourceId

string

影片來源 ID。

重要 當 Episode.N.EpisodeType 為 Resource 時,本參數有效且為必填。

當 Episode.N.EpisodeType 為 Component 時,本參數不可用。

如果您透過 AddCasterVideoResource 介面新增導播台影片來源,請檢視 AddCasterVideoResource 介面呼叫返回的參數 ResourceId 值。

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

StartTime

string

起始時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。必填,未填寫時返回 MissingParameter。

2016-06-29T09:00:00Z

SwitchType

string

切換策略。取值:

重要 當 Episode.N.EpisodeType 為 Resource 時,本參數才有效。

  • TimeFirst:時間優先,直播類影片來源僅允許採用時間優先。

  • ContentFirst:內容優先。

TimeFirst

CasterId

string

導播台 ID。

  • 如果您透過 CreateCaster 介面建立導播台,請檢視 CreateCaster 介面呼叫返回的參數 CasterId 值。

  • 如果您透過直播主控台建立導播台,請透過直播主控台 > 導播台 > 雲端導播台路徑檢視導播台名稱。

說明

直播主控台雲端導播台頁面導播台清單中的導播台名稱即為導播台 ID。

LIVEPRODUCER_POST-cn-0pp1czt****

說明

請求參數中的 N 表示第幾個的意思。例如:
Episode.N.EpisodeName 表示傳入第幾個節目名稱。Episode.1.EpisodeName 表示傳入第 1 個節目名稱,Episode.2.EpisodeName 表示傳入第 2 個節目名稱。

返回參數

名稱

類型

描述

樣本值

object

EpisodeIds

object

EpisodeId

array<object>

節目 ID 清單,清單中元素順序與傳入節目順序保持一致。

object

EpisodeId

string

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

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

RequestId

string

請求 ID。

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

樣本

正常返回樣本

JSON格式

{
  "EpisodeIds": {
    "EpisodeId": [
      {
        "EpisodeId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
      }
    ]
  },
  "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無效,請檢查後重試。
400 InvalidParameter.EndTime %s, please check and try again later. 參數EndTime無效,請檢查後重試。
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. 待操作的元件不存在,請檢查後重試。

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

變更歷史

更多資訊,參考變更詳情