全部產品
Search

搜尋本產品

    Intelligent Media Services：GetCustomTemplate - 擷取自訂模板資訊

    文件中心

    Intelligent Media Services：GetCustomTemplate - 擷取自訂模板資訊

    更新時間：Jun 06, 2026

    擷取ApsaraVideo for Media Processing使用者自訂模板資訊。

    介面說明

    該介面可以根據 TemplateId 擷取指定 ID 的模板資訊；也可以擷取預設範本資訊。 當 TemplateId 非空時，忽略其他參數並擷取指定 TemplateId 的模板資訊；當 TemplateId 為空白時會根據其他參數擷取使用者預設範本。此時 Type 必填。

    模板類型（Type）：

    1. 1：轉碼模板

    2. 2：截圖模板

    3. 3：動圖模板

    4. 4：圖片浮水印模板

    5. 5：文字浮水印模板

    6. 6：字幕模板

    7. 7：AI 智能審核

    8. 8：AI 智能封面

    9. 9：AI 智能擦除

    轉碼模板子類型（Subtype）：

    1. 1：普通轉碼模板（Normal）

    2. 2：音頻轉碼模板（AudioTranscode）

    3. 3：轉封裝（Remux）

    4. 4：窄帶高清 1.0（NarrowBandV1）

    5. 5：窄帶高清 2.0（NarrowBandV2）

    截圖模板子類型（Subtype）：

    1. 1：普通截圖/靜態截圖（Normal）

    2. 2：雪碧圖（Sprite）

    3. 3：WebVtt 截圖（WebVtt）

    AI 審核模板子類型（Subtype）：

    1. 1：視頻審核（Video）

    2. 2：音頻審核（Audio）

    3. 3：圖片審核（Image）

    AI 智能擦除模板子類型（Subtype）：

    1. 1：表徵圖擦除（VideoDelogo）

    2. 2：字幕擦除（VideoDetext）

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    ice:GetCustomTemplate

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    TemplateId

    string

    否

    模板 ID

    ****96e8864746a0b6f3****
    Type

    integer

    否

    擷取預設範本時的模板類型 ID。TemplateId 為空白時該參數必填。

    1
    Subtype

    integer

    否

    模板子類型。

    1

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    請求 ID

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

    object

    模板資訊

    TemplateId

    string

    模板 Id

    ****20b48fb04483915d4f2cd8ac****
    TemplateName

    string

    模板名稱

    Test screenshot template
    Type

    integer

    模板類型 ID

    2
    TypeName

    string

    模板類型名稱

    SnapshotTemplate
    Subtype

    integer

    模板子類型 ID

    1
    SubtypeName

    string

    模板子類型名稱

    Normal
    Status

    string

    模板狀態

    Normal
    IsDefault

    boolean

    是否預設範本

    true
    TemplateConfig

    string

    模板參數

    {"Type":"Normal","FrameType":"normal","Time":0,"Count":10}
    CreateTime

    string

    模板建立時間

    2022-01-01T10:00:00Z
    ModifiedTime

    string

    模板修改時間

    2022-01-01T11:00:00Z

    FrontendHint

    object

    TranscodeTemplateHint

    object

    BitrateControlType

    string

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "CustomTemplate": {
    "TemplateId": "****20b48fb04483915d4f2cd8ac****",
    "TemplateName": "Test screenshot template",
    "Type": 2,
    "TypeName": "SnapshotTemplate",
    "Subtype": 1,
    "SubtypeName": "Normal",
    "Status": "Normal",
    "IsDefault": true,
    "TemplateConfig": "{\"Type\":\"Normal\",\"FrameType\":\"normal\",\"Time\":0,\"Count\":10}",
    "CreateTime": "2022-01-01T10:00:00Z",
    "ModifiedTime": "2022-01-01T11:00:00Z\n",
    "FrontendHint": {
      "TranscodeTemplateHint": {
        "BitrateControlType": ""
      }
    }
  }
}

    錯誤碼

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

    變更歷史

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