全部產品
Search

搜尋本產品

    ApsaraVideo Live：SetShowListBackground

    文件中心

    ApsaraVideo Live：SetShowListBackground

    更新時間：Jun 23, 2026

    進行播單背景設定。

    介面說明

    • 請先建立新播單型導播台，再呼叫本介面添加背景素材。使用 API 建立導播台，請參見建立導播台。

    • 可以使用本介面建立/更新/刪除播單背景， 當參數 ResourceType、ResourceUrl、MaterialId 都為空即可刪除背景。

    重要

    • 使用影片點播（VOD）資源，可優先選擇託管 Bucket 資源，自有 Bucket 資源存在過期風險，如果您選用自有 Bucket 資源，需注意資源的有效期時間。

    • 素材資源輸入請優先選擇影片直播和影片點播的資源，若從第三方 URL 輸入資源存在播放失敗可能性，需確定資源的品質和有效性。

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:SetShowListBackground

    update

    *Caster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地域 ID。

    cn-shanghai
    CasterId

    string

    是

    導播台 ID。

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

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

    說明

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

    LIVEPRODUCER_POST-cn-0pp1czt****
    ResourceType

    string

    否

    素材類型。取值：

    • LIVE：直播素材。可支援直播素材和第三方 URL。

    • VOD：點播素材。可支援點播素材和第三方 URL。

    • PIC：圖片素材。可支援點播素材和第三方 URL。

    說明

    三選一或者不傳。

    枚舉值：

    • VOD :

      點播素材。

    • PIC :

      圖片素材。

    • LIVE :

      直播素材。

    VOD
    MaterialId

    string

    否

    點播素材 ID。

    說明

    與外部 ResourceUrl 二選一。

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

    string

    否

    外部素材 url。

    http://****/atestObject****.m3u8

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    請求 ID。

    987DA143-A39C-5B5D-AF5B-3B07944A0036

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "987DA143-A39C-5B5D-AF5B-3B07944A0036"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidUserId.Malformed %s, please check userId.
    400 MissingParameter %s.
    400 InvalidParameter.Malformed There are invalid parameters: %s.
    400 InvalidParameter.Status %s, please check and try again.
    400 InvalidParameter.StartTime %s, please check and try again later.
    400 InvalidParameter.EndTime %s, please check and try again later.
    400 LiveServiceNotFound %s, please check and try again later.
    500 InternalError %s, please try again later.
    404 InvalidCaster.NotFound The caster does not exist.

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

    變更歷史

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