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

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

调试

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

请求参数

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

系统规定参数。取值:SubmitTranscodeJobs

TemplateGroupId String ea2727ecc0*****5ff43c04878f4e1

使用指定的模板组进行转码,可在控制台转码设置里查看模版组ID。

VideoId String 0222e203cf*****72f9c22870a4d2c

视频ID。

PipelineId String d3e680e618708*****fbf2cae7cc931

管道ID。

EncryptConfig String {"CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt", "DecryptKeyUri":"http://decrypt.demo.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt","KeyServiceType":"KMS"}

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

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

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

Priority String 6

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

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

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

FileUrl String xxx

参数暂不可用。

返回数据

名称 类型 示例值 描述
RequestId String B1DBEFB3-3371-4E*****43-708259D719CE

请求ID。

TranscodeJobs Array of TranscodeJob

媒体作业信息。

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

作业ID。

TranscodeTaskId String 9f4a0df7da2c*****8a81c8c0408c8

当前提交的转码任务ID。

说明 下述请求示例中的“公共请求参数”详情,参见公共参数说明文档

示例

请求示例

http(s)://[Endpoint]/?Action=SubmitTranscodeJobs
&TemplateGroupId=ea2727ecc0*****5ff43c04878f4e1
&<公共请求参数>

正常返回示例

XML 格式

<SubmitTranscodeJobsResponse>
  <RequestId>B1DBEFB3-3371-4E*****43-708259D719CE</RequestId>
  <TranscodeJobs>
        <TranscodeJob>
              <JobId>d8921ce85057*****16cfe86fb112c</JobId>
        </TranscodeJob>
  </TranscodeJobs>
  <TranscodeTaskId>9f4a0df7da2c*****8a81c8c0408c8</TranscodeTaskId>
</SubmitTranscodeJobsResponse>

JSON 格式

{
	"RequestId": "B1DBEFB3-3371-4E*****43-708259D719CE",
	"TranscodeJobs": {
		"TranscodeJob": [
			{
				"JobId": "d8921ce85057*****16cfe86fb112c"
			}
		]
	},
	"TranscodeTaskId": "9f4a0df7da2c*****8a81c8c0408c8"
}

错误码

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

接口错误码

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

错误代码

错误信息

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各语言调用的示例代码,请参考如下: