全部產品
Search

搜尋本產品

    ApsaraVideo Live：SetCasterSceneConfig

    文件中心

    ApsaraVideo Live：SetCasterSceneConfig

    更新時間：Jul 17, 2026

    全量設定場景配置，清空場景配置，並將版面配置資訊設定並生效至指定場景。

    介面說明

    呼叫本介面全量設定場景配置，清空場景配置，並將版面配置資訊設定並生效至指定場景。

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:SetCasterSceneConfig

    update

    *Caster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地域 ID。

    cn-shanghai
    ComponentId

    array

    否

    元件 ID 清單，陣列內按照由下至上的順序排列元件。

    說明

    N 表示第幾個的意思。例如：
    ComponentId.1 表示第一個元件 ID，
    ComponentId.2 表示第二個元件 ID。

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

    string

    否

    元件 ID 清單，陣列內按照由下至上的順序排列元件。

    說明

    N 表示第幾個的意思。例如：
    ComponentId.1 表示第一個元件 ID，
    ComponentId.2 表示第二個元件 ID。

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

    string

    是

    導播台 ID。

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

    • 如果您透過直播控制台建立導播台，請透過直播控制台 > 導播台 > 雲端導播台頁面檢視。

    說明

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

    80787064-1c94-4dc1-85ce-9409960a****
    SceneId

    string

    是

    場景 ID。該場景必須已透過呼叫 StartCasterScene 啟動，否則返回 IncorrectSceneStatus 錯誤。

    242b4e2c-c30f-4442-85ba-2e3e4e3d****
    LayoutId

    string

    否

    版面配置 ID。如果您透過 DescribeCasterLayouts 介面 查詢導播台版面配置清單，請檢視 DescribeCasterLayouts 介面呼叫返回的參數 LayoutId 值。

    0c6da077-f037-49e8-8440-3be13393****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    CF60DB6A-7FD6-426E-9288-122CC1A52FA7

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidCasterId.Malformed %s, please check and try again later. 參數CasterId無效，請檢查後重試。
    400 InvalidUserId.Malformed %s, please check userId. 傳入的userId無效，請檢查。
    400 InvalidSceneId.Malformed %s, please check and try again later. 參數SceneId無效，請檢查後重試。
    400 InvalidCaptionResource %s, please check and try again later. 語音字幕元件引用的資源不存在或不為直播源，請檢查後重試。
    400 IncorrectSceneStatus %s, please check and try again later. Scene狀態不支援，請檢查後重試。
    400 ComponentNumberExceed %s, please check and try again later. 元件數量超限，請檢查後重試。
    400 IncorrectSceneStatus.Idle %s, please check and try again later. Scene狀態為閒置，請檢查後重試。
    400 IncorrectSceneStatus.ConfigError %s, please check and try again later. Scene設定錯誤，請檢查後重試。
    400 InvalidParameter.Malformed There are invalid parameters: %s. 存在無效參數：%s。
    401 IllegalOperation %s, please check and try again later. 錯誤操作，請檢查後重試。
    412 ResourceInChannel.PreConditionFailed %s, please try again later. 資源預校驗失敗，請稍後重試。
    412 ResourceInChannel.Invalid %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 InvalidScene.NotFound %s, please check and try again later. Scene不存在，請檢查後重試。
    404 InvalidLayout.NotFound %s, please check and try again later. LayoutId不存在，請檢查後重試。
    404 InvalidComponent.NotFound %s, please check and try again later. 待操作的元件不存在，請檢查後重試。
    404 ResourceInChannel.NotFound %s, please check and try again later. 資源不存在，請檢查後重試。

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

    變更歷史

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