文档

AddTranscodeTemplateGroup - 创建转码模板组

更新时间:

调用AddTranscodeTemplateGroup添加转码配置信息,可创建新的转码模板组,或者向指定模板组中添加新的转码模板。

接口说明

  • 被视频点播后台锁定的转码模板组不支持自定义操作,您可以调用 GetTranscodeTemplateGroup 接口查询模板配置,通过返回的响应参数 Locked,查看模板组是否被锁定;您可以调用 UpdateTranscodeTemplateGroup 接口将模板解锁后,再进行更改等操作。
  • 由于转码涉及到文件的存储地址,因此如果没有可以正常使用的存储地址,暂不支持添加转码模板组(您可以在视频点播控制台 > 配置管理 > 媒资管理配置 > 存储管理中,激活点播系统 bucket获取可用的存储地址)。
  • 不转码模板组,不允许追加转码模板配置信息。
  • 支持最多创建 20 个转码模板组。
  • 一个转码模板组支持最多添加 20 个转码模板配置。
  • 若需要通过转码生成多码率自适应流地址时,一个转码模板组中支持最多添加 10 个视频打包模板 ,若超过 10 个,则只会生成各码流地址,不会生成自适应流地址。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

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

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

请求参数

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

转码模板组名称。

  • 长度不超过 128 个字节。
  • UTF-8 编码。
说明 TranscodeTemplateGroupId 和 Name 必须传递一个。
transcodetemplate
TranscodeTemplateListstring

转码模板配置信息(JSON 字符串)。参数结构详情,请参见 TranscodeTemplate

说明
  • 该参数不传递,则不会构建转码处理流程,视频上传不会触发转码。
  • 如果不需要设置 Width 或者 Height 属性,则不传相应属性即可,请不要设置为空串,例如:"Height":""。
  • [{"Video":{"Bitrate":"400","Codec":"H.264","Fps":"30","Height":360,"Width":640},"Definition":"SD","Container":{"Format":"mp4"},"TemplateName":"testName","MuxConfig":{},"Audio":{"Codec":"AAC","Bitrate":"64","Samplerate":"44100"}}]
    TranscodeTemplateGroupIdstring

    转码模板组 ID。若指定了转码模板组 ID,则可向指定的模板组中添加新的转码模板。

    说明 TranscodeTemplateGroupId 和 Name 必须传递一个。
    4c71a339fe52b4fa6f4527****
    AppIdstring

    应用 ID。默认取值: app-1000000。使用说明,请参见多应用

    app-****

    返回参数

    名称类型描述示例值
    object

    返回参数。

    TranscodeTemplateGroupIdstring

    转码模板组 ID。

    34e908aa4024af7821c31f93a2a****
    RequestIdstring

    请求 ID。

    25818875-5F78-4AF6-D7393642CA58****

    示例

    正常返回示例

    JSON格式

    {
      "TranscodeTemplateGroupId": "34e908aa4024af7821c31f93a2a****",
      "RequestId": "25818875-5F78-4AF6-D7393642CA58****"
    }

    错误码

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

    接口错误码

    下表列举了本接口特有的错误码。

    错误代码错误信息HTTP 状态码说明
    InvalidStorage.NotFoundThe storage info dose not exist.404不存在存储地址数据。
    InvalidTranscodeTemplateGroup.NotFoundThe transcode template group does not exist.404指定的转码模板组不存在。
    Forbidden.LockedTemplateGroupThe transcode template group has been locked.403指定的模板组被锁定,不可操作,请联系点播后台。
    Forbidden.SpecialTemplateGroupThe transcode template group is using for special purpose.403特殊用途转码模板组,不允许追加转码模板配置,例如:不转码即分发模板组、仅存储模板组。
    TrasncodeTemplateGroupExceededMaxThe transcode template group size exceeded maximum.400转码模板组数据达到上限,转码模板组最大支持创建 20 个。
    TranscodeTemplateExceededMaxThe template transcode template config size exceeded maximum.400转码模板组关联的转码模板配置数据达到上限,最大支持关联 20 个转码模板配置。
    WatermarkExceededMaxThe watermark size exceeded maximum.400转码模板组下单个转码模板能关联的水印 ID 数达到上限,最大支持关联 4 个水印 ID。
    • 本页导读 (1)
    文档反馈