SubmitTranscodeJobs - 提交媒体转码作业 - 视频点播

调用本接口提交媒体转码作业，开始异步转码处理。

接口说明

使用说明

请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。转码为付费功能，计费详情，请参见媒资转码计费。
只有状态为上传完成、正常和审核中的视频才能发起转码。
如需要获取转码结果，可接收回调消息：单个清晰度转码完成、全部转码完成。
该接口可支持 HLS 自适应码流打包任务中对字幕地址进行动态替换，如打包任务无字幕打包处理，不建议采用该接口发起任务处理，而建议视频上传时设置对应的打包模板组 ID 即可自动发起打包流程。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vod:SubmitTranscodeJobs	create	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
VideoId	string	是	视频 ID。可通过以下方式获取：通过控制台上传的视频，可登录点播控制台，选择媒资库 > 音/视频查看视频 ID。通过 CreateUploadVideo 接口上传视频时，视频 ID 为返回参数 VideoId 的值。视频上传后，可通过 SearchMedia 接口查询视频 ID，为请求后返回参数 VideoId 的值。	142710f878bd42508932f660d7b1****
TemplateGroupId	string	是	视频转码时使用的转码组 ID。使用指定的模板组进行转码，您可以登录点播控制台，选择配置管理 >媒体处理配置 > 转码模板组查看模版组 ID。	0e408c803baf658ee637790c5d9f****
PipelineId	string	否	管道 ID。	d3e680e618708erf45fbf2cae7c****
EncryptConfig	string	否	加密配置，为 JSON 字符串，只有使用 HLS 标准加密时才需要此参数。说明 EncryptConfig 结构体中 CipherText 参数必须为通过 GenerateKMSDataKey 生成的 AES_128 密文密钥，否则标准加密转码失败。标准加密接入流程，请参见 HLS 标准加密。无论标准加密、私有加密，TemplateGroupId 对应的模板数据，必须都勾选 HLS 加密选项，否则不加密。	{"CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk3**", "DecryptKeyUri":"http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3**","KeyServiceType":"KMS"}
OverrideParams	string	否	覆盖参数（JSON 字符串），支持对转码模板关联的指定图片水印文件、文字水印内容、字幕文件地址以及字幕文件编码格式的覆盖。参数结构详情，请参见 OverrideParams 。	{"Watermarks":[{"WatermarkId":"af2afe4761992c47dae973374**","FileUrl":"http://developer.aliyundoc.com/image/image.png"},{"WatermarkId":"e8e5b8038d7ada85b376c2707**","Content":"watermark test"}]}
Priority	string	否	当前发起的转码作业在所有排队作业中的优先级。取值范围：1~10。最高优先级：10。默认值：6。说明 Priority 参数只影响当前发起的转码作业在所有排队状态作业中的优先级，但不影响已经转码处理中的任务优先级。	6
UserData	string	否	自定义设置。为 JSON 字符串，支持消息回调等设置。具体详情，请参见 UserData 。说明此参数中消息回调的使用前提是需要在控制台配置 HTTP 回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。	{"Extend":{"localId":"**","test":"*"}}
SessionId	string	否	自定义去重识别码，如果 7 天内曾有过相同的识别码的请求，则本次的请求会返回错误。长度最长为 50 个字符，支持大小写英文字母、数字、短划线（-）和下划线（_），不传或者带空字符串表示不去重。	5c62d40299034bbaa4c195da330****

返回参数

名称	类型	描述	示例值
	object	返回结果。
TranscodeTaskId	string	当前提交的转码任务 ID。	9f4a0df7da2c8a81c8c0408c84****
RequestId	string	请求 ID。	E4EBD2BF-5EB0-4476-8829-9D94E1B1****
TranscodeJobs	array<object>	媒体作业信息。说明 HLS 多码率自适应打包任务不会返回该参数，需要异步接收回调处理结果。
TranscodeJob	object	媒体作业详情。
JobId	string	作业 ID。说明 HLS 多码率自适应打包任务不会返回该参数，需要异步接收回调处理结果。	d8921ce8505716cfe86fb112c4****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-11-28	OpenAPI 入参发生变更	查看变更详情

接口错误码

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

错误代码	错误信息	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	视频状态无效。只有状态为上传完成、正常和审核中的视频才能发起转码。