调用SubmitTranscodeJobs提交媒体转码作业,开始异步转码处理。

使用说明

  • 只有状态为上传完成、正常和审核中的视频才能发起转码。
  • 如需要获取转码结果,可接收回调消息:单个清晰度转码完成全部转码完成
  • 该接口可支持HLS自适应码流打包任务中对字幕地址进行动态替换,如打包任务无字幕打包处理,不建议采用该接口发起任务处理,而建议视频上传时设置对应的打包模板组ID即可自动发起打包流程。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String SubmitTranscodeJobs

系统规定参数。取值:SubmitTranscodeJobs

VideoId String 142710f878bd42508932f660d7b1****

视频ID。可通过以下方式获取:

  • 通过控制台上传的视频,可登录点播控制台,选择媒资库 > 音/视频查看视频ID。
  • 通过CreateUploadVideo接口上传视频时,视频ID为返回参数VideoId的值。
  • 视频上传后,可通过SearchMedia接口查询视频ID,为请求后返回参数VideoId的值。
说明 VideoId参数目前为必填参数。
TemplateGroupId String 0e408c803baf658ee637790c5d9f****

视频转码时使用的转码组ID。使用指定的模板组进行转码,您可以登录点播控制台,选择配置管理 >媒体处理配置 > 转码模板组查看模版组ID。

PipelineId String d3e680e618708erf45fbf2cae7c****

管道ID。

EncryptConfig String {"CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk3****", "DecryptKeyUri":"http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3****","KeyServiceType":"KMS"}

加密配置,为JSON字符串,只有使用HLS标准加密时才需要此参数。

说明
  • EncryptConfig结构体中CipherText参数必须为通过GenerateDataKey生成的AES_128密文密钥,否则标准加密转码失败。标准加密接入流程,请参见HLS标准加密
  • 无论标准加密、私有加密,TemplateGroupId对应的模板数据,必须都勾选HLS加密选项,否则不加密。
OverrideParams String {"Watermarks":[{"WatermarkId":"af2afe4761992c47dae973374****","FileUrl":"http://developer.aliyundoc.com/image/image.png"},{"WatermarkId":"e8e5b8038d7ada85b376c2707****","Content":"水印测试"}]}

覆盖参数(JSON字符串),支持对转码模板关联的指定图片水印文件、文字水印内容、字幕文件地址以及字幕文件编码格式的覆盖。参数结构详情,请参见OverrideParams

Priority String 6

当前发起的转码作业在所有排队作业中的优先级。

  • 取值范围:1~10
  • 最高优先级:10
  • 默认值:6
说明 Priority参数只影响当前发起的转码作业在所有排队状态作业中的优先级,但不影响已经转码处理中的任务优先级。
UserData String {"Extend":{"localId":"****","test":"***"}}

自定义设置。为JSON字符串,支持消息回调等设置。具体详情,请参见UserData

说明 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用,否则回调设置不生效。

返回数据

名称 类型 示例值 描述
TranscodeTaskId String 9f4a0df7da2c8a81c8c0408c84****

当前提交的转码任务ID。

RequestId String E4EBD2BF-5EB0-4476-8829-9D94E1B1****

请求ID。

TranscodeJobs Array of TranscodeJob

媒体作业信息。

说明 HLS多码率自适应打包任务不会返回该参数,需要异步接收回调处理结果。
TranscodeJob
JobId String d8921ce8505716cfe86fb112c4****

作业ID。

说明 HLS多码率自适应打包任务不会返回该参数,需要异步接收回调处理结果。

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=SubmitTranscodeJobs
&VideoId=142710f878bd42508932f660d7b1****
&TemplateGroupId=0e408c803baf658ee637790c5d9f****
&PipelineId=d3e680e618708erf45fbf2cae7c****
&EncryptConfig={"CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk3****", "DecryptKeyUri":"http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3****","KeyServiceType":"KMS"}
&OverrideParams={"Watermarks":[{"WatermarkId":"af2afe4761992c47dae973374****","FileUrl":"http://developer.aliyundoc.com/image/image.png"},{"WatermarkId":"e8e5b8038d7ada85b376c2707****","Content":"水印测试"}]}
&Priority=6
&UserData={"Extend":{"localId":"****","test":"***"}}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SubmitTranscodeJobsResponse>
    <TranscodeTaskId>9f4a0df7da2c8a81c8c0408c84****</TranscodeTaskId>
    <RequestId>E4EBD2BF-5EB0-4476-8829-9D94E1B1****</RequestId>
    <TranscodeJobs>
        <JobId>d8921ce8505716cfe86fb112c4****</JobId>
    </TranscodeJobs>
</SubmitTranscodeJobsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TranscodeTaskId" : "9f4a0df7da2c8a81c8c0408c84****",
  "RequestId" : "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
  "TranscodeJobs" : [ {
    "JobId" : "d8921ce8505716cfe86fb112c4****"
  } ]
}

错误码

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

接口错误码

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

错误代码

错误信息

HTTP 状态码

说明

InvalidVideo.NotFound

The video does not exist.

404

视频不存在。

NoSuchResource

The specified resource %s does not exist.

404

用户相关的资源数据不存在, %s表示具体资源信息。

Forbidden.IllegalStatus

Status of the video is illegal.

400

视频状态无效。只有状态为上传完成正常审核中的视频才能发起转码。

SDK示例

建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: