全部產品
Search

搜尋本產品

    Intelligent Media Services：GetTemplate - 擷取模板資訊

    文件中心

    Intelligent Media Services：GetTemplate - 擷取模板資訊

    更新時間：Mar 21, 2026

    根據模板ID擷取模板資訊。進階模板有解析過長，當類型為進階模板時，Status為Available時即可使用。

    介面說明

    模板工廠是對剪輯合成時間軸的一個封裝，使用者可以把常用的時間軸定義成模板，當有同樣的需求出現時，只需要傳入關鍵參數及素材即可生產視頻。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    ice:GetTemplate

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    TemplateId

    string

    否

    模板 Id

    ****20b48fb04483915d4f2cd8ac****
    RelatedMediaidFlag

    string

    否

    相關媒體 ID 標記，預設值 0，當值為 1 時返回模板關聯素材，僅普通模板有效。

    0

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資料

    RequestId

    string

    請求 Id

    ******11-DB8D-4A9A-875B-275798******
    Template

    object

    模板資訊

    TemplateId

    string

    模板 ID

    ****20b48fb04483915d4f2cd8ac****
    Name

    string

    模板名稱

    視頻添加浮水印模板
    Type

    string

    模板類型，目前支援：

    • Timeline: 普通模版

    • VETemplate: 進階模版

    • BatchEditing: 一鍵成片模版

    Timeline
    Config

    string

    模板配置

    參考Timeline模板配置詳解
    PreviewMedia

    string

    預覽素材

    ****20b48fb04483915d4f2cd8ac****
    Status

    string

    模板狀態，取值範圍

    • Available

    • Created

    • Uploading

    • Processing

    • UploadFailed

    • ProcessFailed

    Available
    CreateSource

    string

    建立來源，取值範圍：

    • AliyunConsole

    • OpenAPI

    • WebSDK

    OpenAPI
    ModifiedSource

    string

    修改來源，取值範圍：

    • AliyunConsole

    • OpenAPI

    • WebSDK

    OpenAPI
    PreviewMediaStatus

    string

    預覽素材狀態

    • Init（初始狀態：源檔案未就緒）

    • Preparing（源檔案準備中：比如上傳中或者剪輯合成中）

    • PrepareFail（源檔案準備失敗：比如擷取源檔案資訊失敗）

    • Normal（正常：源檔案已就緒）

    Normal
    CreationTime

    string

    建立時間

    2020-12-26T04:11:10Z
    ModifiedTime

    string

    修改時間

    2020-12-26T04:11:10Z
    CoverURL

    string

    封面 URL

    http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg
    ClipsParam

    string

    提交合成任務的 ClipsParam 參數模板，可把 mediaId 和 text 換成真實的參數來提交合成任務。使用方式參考：

    {"Media1":"mediaId","Text1":"text"}
    RelatedMediaids

    string

    模板關聯素材，普通模板編輯器使用

    {"video":["******c04f1d4a06996144cc1a******"],"audio":["******c04f1d4a06996144cc1a******"],"image":["******c04f1d4a06996144cc1a******"]}

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Template": {
    "TemplateId": "****20b48fb04483915d4f2cd8ac****",
    "Name": "視頻添加浮水印模板",
    "Type": "Timeline",
    "Config": "參考Timeline模板配置詳解",
    "PreviewMedia": "****20b48fb04483915d4f2cd8ac****",
    "Status": "Available",
    "CreateSource": "OpenAPI",
    "ModifiedSource": "OpenAPI",
    "PreviewMediaStatus": "Normal",
    "CreationTime": "2020-12-26T04:11:10Z",
    "ModifiedTime": "2020-12-26T04:11:10Z",
    "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg",
    "ClipsParam": "{\"Media1\":\"mediaId\",\"Text1\":\"text\"}",
    "RelatedMediaids": "{\"video\":[\"******c04f1d4a06996144cc1a******\"],\"audio\":[\"******c04f1d4a06996144cc1a******\"],\"image\":[\"******c04f1d4a06996144cc1a******\"]}"
  }
}

    錯誤碼

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

    變更歷史

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