GetCustomTemplate - 获取自定义模板信息

获取媒体处理用户自定义模板信息。

接口说明

该接口可以根据 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:GetCustomTemplateget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
TemplateIdstring

模板 ID

****96e8864746a0b6f3****
Typeinteger

获取默认模板时的模板类型 ID。TemplateId 为空时该参数必填。

1
Subtypeinteger

模板子类型。

1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

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

模板信息

TemplateIdstring

模板 Id

****20b48fb04483915d4f2cd8ac****
TemplateNamestring

模板名称

测试截图模板
Typeinteger

模板类型 ID

2
TypeNamestring

模板类型名称

SnapshotTemplate
Subtypeinteger

模板子类型 ID

1
SubtypeNamestring

模板子类型名称

Normal
Statusstring

模板状态

Normal
IsDefaultboolean

是否默认模板

true
TemplateConfigstring

模板参数

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

模板创建时间

2022-01-01T10:00:00Z
ModifiedTimestring

模板修改时间

2022-01-01T11:00:00Z

示例

正常返回示例

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-18OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-07-11新增 OpenAPI查看变更详情