服务端 API 文档

使用任务流模板进行视频处理

最近更新时间:2020-07-13 08:57:26

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

使用任务流模板,对点播中的视频发起处理任务。 有两种方式创建任务流模板:

  1. 在控制台上创建和修改任务流模板;
  2. 通过任务流模板接口创建任务流模板。

如使用事件通知,事件通知的类型为 任务流状态变更

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ProcessMediaByProcedure。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,本接口不需要传递此参数。
FileId String 媒体文件 ID。
ProcedureName String 任务流模板名字。
TasksPriority Integer 任务流的优先级,数值越大优先级越高,取值范围是-10到10,不填代表0。
TasksNotifyMode String 任务流状态变更通知模式,可取值有 Finish,Change 和 None,不填代表 Finish。
SessionContext String 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
SessionId String 用于去重的识别码,如果一天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
ExtInfo String 保留字段,特殊用途时使用。
SubAppId Integer 点播子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。

3. 输出参数

参数名称 类型 描述
TaskId String 任务 ID。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 以任务流模板名的方式发起任务

对 fileId 为 5285485487985271487 的发起任务,使用的任务流模板名为 TranscodeAndSnapshot。

输入示例

https://vod.tencentcloudapi.com/?Action=ProcessMediaByProcedure
&FileId=5285485487985271487
&ProcedureName=TranscodeAndSnapshot
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
    "TaskId": "125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.FileId FileId 不存在。
InvalidParameterValue.ProcedureName 任务流模板名无效。
InvalidParameterValue.SessionContextTooLong SessionContext 过长。
InvalidParameterValue.SessionId 去重识别码重复,请求被去重。
InvalidParameterValue.SessionIdTooLong SessionId 过长。
InvalidParameterValue.SubAppId 参数值错误:子应用 ID。
InvalidParameterValue.UniqueIdentifier 去重识别码一天内重复,请求被去重。
UnauthorizedOperation 未授权操作。
目录