文档首页/视频点播 VOD/API参考/转码模板管理/创建自定义转码模板 - CreateTranscodeTemplate
更新时间：2026-02-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建自定义转码模板 - CreateTranscodeTemplate

功能介绍

创建自定义转码模板。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    vod:templateGroup:create

    Write

    -

    -

    -

    -

URI

POST /v2/{project_id}/asset/template/transcodings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token，使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

模板组名称

is_default

否

Boolean

是否设置成默认转码模板，默认false不设置为默认

is_auto_encrypt

否

Boolean

配置是否加密输出音视频，默认false不加密。

当前只支持加密输出HLS格式的音视频流，不会对原始上传的音视频进行加密处理。非HLS转码输出的音视频格式，此字段不可配置。开启此配置前，请参考《VOD用户指南》的“HLS加密设置”章节获取密钥URL。

quality_info_list

是

Array of QualityInfoList objects

画质配置信息列表

common

是

CommonInfo object

高清低码开关，编码格式多路共同参数

watermark_template_ids

否

Array of strings

绑定的水印模板组ID数组

description

否

String

模板介绍

表4 QualityInfoList

参数

是否必选

参数类型

描述

video

否

VideoInfo object

模板视频信息。video和audio至少配置一个参数。

audio

否

AudioInfo object

模板音频信息

表5 VideoInfo

参数

是否必选

参数类型

描述

quality

是

String

画质

  • 4K默认分辨率3840*2160，码率8000kbit/s

  • 2K默认分辨率2560*1440，码率7000kbit/s

  • FULL_HD默认分辨率1920*1080，码率3000kbit/s

  • HD默认分辨率1280*720，码率1000kbit/s

  • SD默认分辨率854*480，码率600kbit/s

  • FLUENT默认分辨率480*270，码率300kbit/s

width

否

Integer

视频宽度

H264编码：0或[32,4096]之间2的整数倍

H265编码：0或[160,4096]之间2的整数倍

height

否

Integer

视频高度

H264编码：0或[32,2880]之间2的整数倍

H265编码：0或[160,2880]之间2的整数倍

bitrate

是

Integer

平均码率，单位：kbit/s。

参考取值范围：0或[40,30000]之间的整数。

frame_rate

是

Integer

帧率，单位是帧每秒。

取值范围：[0-75]之间的整数，小于5帧或大于60帧代表自适应。

表6 AudioInfo

参数

是否必选

参数类型

描述

sample_rate

是

String

音频采样率（有效值范围）

  • AUDIO_SAMPLE_AUTO (default),

  • AUDIO_SAMPLE_22050：22050Hz

  • AUDIO_SAMPLE_32000：32000Hz

  • AUDIO_SAMPLE_44100：44100Hz

  • AUDIO_SAMPLE_48000：48000Hz

  • AUDIO_SAMPLE_96000：96000Hz

bitrate

否

Integer

音频码率（单位：Kbps）

channels

是

String

声道数（有效值范围）

  • AUDIO_CHANNELS_1:单声道

  • AUDIO_CHANNELS_2：双声道 (default)

  • AUDIO_CHANNELS_5_1：5.1声道

表7 CommonInfo

参数

是否必选

参数类型

描述

pvc

否

Boolean

高清低码开关

video_codec

否

String

视频编码格式

  • H264

  • H265

audio_codec

否

String

音频编码格式

  • AAC：AAC格式 (default)

  • HEAAC1：HEAAC1格式

  • HEAAC2：HEAAC2格式

  • MP3：MP3格式

is_black_cut

否

Boolean

黑边剪裁类型，默认false不开启黑边剪裁

format

是

String

转码格式

  • MP4

  • HLS

  • DASH

  • DASH_HLS

  • MP3

  • ADTS

  • UNKNOW

hls_interval

否

Integer

分片时长，范围2-10（默认为5秒）

upsample

否

Boolean

上采样开关，开启后可以提升视频的分辨率，增加采样点的数量，默认值:false，表示不开启上采样。

adaptation

否

String

转码后的片源分辨率自适应方式。

取值如下：

  • SHORT：短边自适应。转码模板的宽和高都设置，用其中的短边与片源短边对比，然后片源长边按此比例进行缩放。

  • LONG：长边自适应。转码模板的宽和高都设置，用其中的长边与片源长边对比，然后片源短边按此比例进行缩放。

  • NONE：按设置宽高适应，为默认值。按照转码模板设置的宽高输出。

说明：

  • V1接口（已废弃）不支持设置该参数，默认按SHORT处理。V2接口默认按NONE处理，V1和V2接口默认值有差异，在调用时需要注意该参数值的设置。

  • 控制台是通过V2接口创建的转码模板，实际与V1接口创建转码模板的默认值保持一致，为SHORT。

preset

否

Integer

编码质量等级，取值[0,2] 0表示默认方式，1表示转码效率优先，2表示转码质量优先。

max_iframes_interval

否

Integer

I帧最大间隔，取值范围：[2，10]。默认值：5，单位秒。

hls_audio_separate

否

Boolean

转码后音频是否独立存储。

hls_segment_type

否

String

HLS分片的封装格式，目前支持TS和FMP4，默认TS格式

响应参数

状态码：201

表8 响应Body参数

参数

参数类型

描述

group_id

String

模板组ID

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

创建转码模板

POST https://{endpoint}/v2/{project_id}/asset/template/transcodings

Content-Type: application/json
{
  "name": "trans_template_test",
  "is_default": true,
  "is_auto_encrypt": false,
  "quality_info_list": [
    {
      "video": {
        "width": 1280,
        "height": 720,
        "bitrate": 1000,
        "quality": "HD",
        "frame_rate": 0
      },
      "audio": {
        "sample_rate": "AUDIO_SAMPLE_AUTO",
        "channels": "AUDIO_CHANNELS_1",
        "bitrate": 0
      }
    }
  ],
  "watermark_template_ids": [],
  "common": {
    "pvc": false,
    "video_codec": "H264",
    "audio_codec": "AAC",
    "format": "HLS",
    "hls_interval": 5
  }
}

响应示例

状态码：201

处理成功返回。

{
  "group_id" : "f9b045e0811c482f9de0d436a5927bb6"
}

状态码：400

处理失败返回。

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

状态码

状态码

描述

201

处理成功返回。

400

处理失败返回。

错误码

请参见错误码。

父主题：转码模板管理

相关文档