獲取媒體處理用戶自定義模板信息。
接口說明
該接口可以根據 TemplateId 獲取指定 ID 的模板信息;也可以獲取默認模板信息。 當 TemplateId 非空時,忽略其他參數并獲取指定 TemplateId 的模板信息;當 TemplateId 為空時會根據其他參數獲取用戶默認模板。此時 Type 必填。
模板類型(Type):
- 1:轉碼模板
- 2:截圖模板
- 3:動圖模板
- 4:圖片水印模板
- 5:文字水印模板
- 6:字幕模板
- 7:AI 智能審核
- 8:AI 智能封面
- 9:AI 智能擦除
轉碼模板子類型(Subtype):
- 1:普通轉碼模板(Normal)
- 2:音頻轉碼模板(AudioTranscode)
- 3:轉封裝(Remux)
- 4:窄帶高清 1.0(NarrowBandV1)
- 5:窄帶高清 2.0(NarrowBandV2)
截圖模板子類型(Subtype):
- 1:普通截圖/靜態截圖(Normal)
- 2:雪碧圖(Sprite)
- 3:WebVtt 截圖(WebVtt)
AI 審核模板子類型(Subtype):
- 1:視頻審核(Video)
- 2:音頻審核(Audio)
- 3:圖片審核(Image)
AI 智能擦除模板子類型(Subtype):
- 1:圖標擦除(VideoDelogo)
- 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 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"CustomTemplate": {
"TemplateId": "****20b48fb04483915d4f2cd8ac****",
"TemplateName": "測試截圖模板",
"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": ""
}
}
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2022-07-18 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2022-07-11 | 新增 OpenAPI | 查看變更詳情 |