全部產品
Search

搜尋本產品

    ApsaraVideo Live：CreateCustomTemplate - 建立合流自訂模板

    文件中心

    ApsaraVideo Live：CreateCustomTemplate - 建立合流自訂模板

    更新時間：Aug 14, 2025

    建立合流自訂模板。

    介面說明

    調用本介面建立好自訂模板後，請記錄模板名。通過 CreateMixStream 介面建立合流任務時，MixStreamTemplate 傳入模板名來使用自訂模板。

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:CreateCustomTemplate

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地區 ID。

    cn-shanghai
    CustomTemplate

    string

    是

    JSON 格式{height:xxx,scale:xxx,gop:xxx,bframes:xxx,cdesc:xxx}，所有欄位均必填，缺少其中任意欄位會調用失敗。

    說明

    具體參數請參考下表CustomTemplate 說明。

    {"height":"1060","scale":"[16:9]","gop":"60","bframes":"30","cdesc":"h264"}
    Template

    string

    是

    需要添加的模板名。

    說明

    請在建立時記錄模板名，用於使用、查詢和刪除操作。

    TestTemplate

    CustomTemplate 說明

    名稱

    類型

    必選

    描述

    height

    String

    必選

    輸出解析度的高。
    scale 為 16:9 時最大支援 1920x1080。
    scale 為 4:3 時最大支援 1440x1080 。




    scale

    String

    必選

    輸出解析度高寬比。只能接受 String 取值如下：
    [3:4]
    [4:3]
    [16:9]
    [9:16]










    bframes

    String

    必選

    輸出資料流 b 幀數。取值需要大於 0 小於 9。

    cdesc

    String

    必選

    編碼格式。只能取值 h264。

    gop

    String

    必選

    主要畫面格間隔。取值大於 25 小於 250。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    0D715397-2E66-4AE1-694h-C546628AD145

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "0D715397-2E66-4AE1-694h-C546628AD145"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 TemplateAlreadyExist %s
    400 InvalidUserId.Malformed %s
    400 InvalidParameter.Malformed %s
    400 MissingParameter %s
    400 CustomTemplateInvalid %s
    500 InternalError %s
    404 InvalidDomainName.NotFound %s

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

    變更歷史

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