调用SubmitTranscodeJobs提交媒体转码作业,开始异步转码处理。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vod:SubmitTranscodeJobs |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
VideoId | string | 是 | 视频 ID。可通过以下方式获取:
| 142710f878bd42508932f660d7b1**** |
TemplateGroupId | string | 是 | 视频转码时使用的转码组 ID。使用指定的模板组进行转码,您可以登录点播控制台,选择配置管理 >媒体处理配置 > 转码模板组查看模版组 ID。 | 0e408c803baf658ee637790c5d9f**** |
PipelineId | string | 否 | 管道 ID。 | d3e680e618708erf45fbf2cae7c**** |
EncryptConfig | string | 否 | 加密配置,为 JSON 字符串,只有使用 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 | 否 | 当前发起的转码作业在所有排队作业中的优先级。
说明
Priority 参数只影响当前发起的转码作业在所有排队状态作业中的优先级,但不影响已经转码处理中的任务优先级。
| 6 |
UserData | string | 否 | 自定义设置。为 JSON 字符串,支持消息回调等设置。具体详情,请参见 UserData 。 说明
此参数中消息回调的使用前提是需要在控制台配置 HTTP 回调地址和勾选对应的回调事件类型才能使用,否则回调设置不生效。
| {"Extend":{"localId":"****","test":"***"}} |
返回参数
示例
正常返回示例
JSON
格式
{
"TranscodeTaskId": "9f4a0df7da2c8a81c8c0408c84****",
"RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
"TranscodeJobs": {
"TranscodeJob": [
{
"JobId": "d8921ce8505716cfe86fb112c4****"
}
]
}
}
错误码
访问错误中心查看更多错误码。