全部產品
Search

搜尋本產品

    ApsaraVideo Live：AddPlaylistItems - 添加播放清單項

    文件中心

    ApsaraVideo Live：AddPlaylistItems - 添加播放清單項

    更新時間：Aug 14, 2025

    添加節目單項。

    介面說明

    先建立導播台，添加導播檯布局和導播台組件，再調用本介面添加節目單項。若沒有建立過節目單，則直接建立。使用 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。不填則預設建立一個新的節目單。

    445409ec-7eaa-461d-8f29-4bec2eb9****
    ProgramConfig

    string

    否

    節目單項配置。若首次添加，傳該參數進行初始化配置。更多資訊，請參見 ProgramConfig。

    [{"RepeatNumber":"0","ProgramName":"my program"}]

    InputProgramItem

    參數名稱

    樣本值

    類型

    描述

    ItemName

    item1

    String

    節目單項名稱。

    ResourceType

    vod

    String

    資源類型。取值：
    vod：阿里雲ApsaraVideo for 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
    400 PlayListIsEmpty %s
    400 MissInputParams %s
    400 InvalidProgramId.Malformed %s
    400 InvalidParameter.Malformed %s
    500 InternalError %s
    403 UserQuotaExceed %s
    404 InvalidCaster.NotFound %s
    404 InvalidDomainName.NotFound %s

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

    變更歷史

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