调用ListCustomTemplates获取自定义模板列表_智能媒体服务(IMS)-阿里云帮助中心

获取用户自定义点播媒体处理模板列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ice:ListCustomTemplates	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Type	string	是	模板类型。 1：转码模板 2：截图模板 3：动图模板 4：图片水印模板 5：文字水印模板 6：字幕模板 7：AI 智能审核 8：AI 智能封面 9：AI 智能擦除	1
Subtype	string	否	模板子类型 ID。转码模板子类型： 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）	2
Name	string	否	模板名称。	test-template
TemplateId	string	否	模板 ID。	**96e8864746a0b6f3**
PageNumber	integer	否	分页数目。	1
PageSize	integer	否	分页大小。	20
OrderBy	string	否	排序顺序。取值： CreateTimeDesc（按照创建时间逆序排列） CreateTimeAsc（按照创建时间顺序排列）	CreateTimeDesc

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	****11-DB8D-4A9A-875B-275798****
Total	integer	模板总数。	20
CustomTemplateList	array<object>	模板信息列表。
CustomTemplate	object	自定义模板信息。
TemplateId	string	模板 ID。	**20b48fb04483915d4f2cd8ac**
TemplateName	string	模板名称。	test-template
Type	integer	模板类型 ID。	1
TypeName	string	模板类型名称。	TranscodeTemplate
Subtype	integer	模板子类型 ID。	2
SubtypeName	string	模板子类型名称。	AudioTranscode
Status	string	模板状态。枚举值： Normal：Normal。	Normal
IsDefault	boolean	是否默认模板。枚举值： true：true。 false：false。	true
TemplateConfig	string	模板参数。	{"Container":{"Format":"mp3"},"Audio":{"Codec":"mp3","Bitrate":"64","Samplerate":"22050","Channels":"2"}}
CreateTime	string	模板创建时间。	2022-07-12T16:17:54Z
ModifiedTime	string	模板修改时间。	2022-07-12T16:17:54Z

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Total": 20,
  "CustomTemplateList": [
    {
      "TemplateId": "****20b48fb04483915d4f2cd8ac****",
      "TemplateName": "test-template",
      "Type": 1,
      "TypeName": "TranscodeTemplate",
      "Subtype": 2,
      "SubtypeName": "AudioTranscode",
      "Status": "Normal",
      "IsDefault": true,
      "TemplateConfig": "{\"Container\":{\"Format\":\"mp3\"},\"Audio\":{\"Codec\":\"mp3\",\"Bitrate\":\"64\",\"Samplerate\":\"22050\",\"Channels\":\"2\"}}",
      "CreateTime": "2022-07-12T16:17:54Z",
      "ModifiedTime": "2022-07-12T16:17:54Z",
      "FrontendHint": {
        "TranscodeTemplateHint": {
          "BitrateControlType": ""
        }
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2022-07-18	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-07-11	新增 OpenAPI	查看变更详情