帮你快速理解、总结文档立即下载

创建任务流模板

最近更新时间:2026-09-15 04:13:08
我的收藏

1. 接口描述

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

创建用户自定义的任务流模板,模板上限:50。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:CreateProcedureTemplate。
Version 是 String 公共参数,本接口取值:2018-07-17。
Region 否 String 公共参数,此参数为可选参数。
Name 是 String

任务流名字(支持中文,不超过20个字)。


示例值:我的一个任务流
SubAppId 否 Integer

点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。


示例值:1490012345
Comment 否 String

模板描述信息,长度限制:256 个字符。


示例值:test template
MediaProcessTask 否 MediaProcessTaskInput

视频处理类型任务参数。

AiContentReviewTask 否 AiContentReviewTaskInput

AI 内容审核类型任务参数 。
:该参数用于发起旧版审核,不建议使用。推荐使用 ReviewAudioVideoTask 参数发起审核。

AiAnalysisTask 否 AiAnalysisTaskInput

AI 内容分析类型任务参数。

AiRecognitionTaskSet.N 否 Array of AiRecognitionTaskInput

AI 内容识别类型任务参数。

ReviewAudioVideoTask 否 ProcedureReviewAudioVideoTaskInput

音视频审核类型任务参数。

ImportMediaKnowledgeTaskSet.N 否 Array of ImportMediaKnowledgeTaskInput

导入智能媒资知识库任务参数。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建一个发起内容审核任务的任务流模板

创建一个名为“我的一个任务流”的任务流模板,发起内容审核任务 (包括涉及令人反感的信息、涉及不安全的信息、涉及不适宜的信息),使用的内容审核模板 ID 是 10。

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProcedureTemplate
<公共请求参数>

{
    "AiContentReviewTask": {
        "Definition": 10
    },
    "Name": "我的一个任务流"
}

输出示例

{
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

示例2 创建一个发起带水印的转码任务的任务流模板

创建一个名为“我的一个任务流”的任务流模板,转出20,30,40三种格式,并且转出的每一个视频都打上一个水印,水印的模板 ID 为15780。

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProcedureTemplate
<公共请求参数>

{
    "MediaProcessTask": {
        "TranscodeTaskSet": [
            {
                "Definition": 30,
                "WatermarkSet": [
                    {
                        "EndTimeOffset": 0,
                        "Definition": 15780,
                        "TextContent": " ",
                        "SvgContent": " ",
                        "StartTimeOffset": 0
                    }
                ]
            },
            {
                "Definition": 20,
                "WatermarkSet": [
                    {
                        "EndTimeOffset": 0,
                        "Definition": 15780,
                        "TextContent": " ",
                        "SvgContent": " ",
                        "StartTimeOffset": 0
                    }
                ]
            },
            {
                "Definition": 40,
                "WatermarkSet": [
                    {
                        "EndTimeOffset": 0,
                        "Definition": 15780,
                        "TextContent": " ",
                        "SvgContent": " ",
                        "StartTimeOffset": 0
                    }
                ]
            }
        ]
    },
    "Name": "我的一个任务流"
}

输出示例

{
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

示例3 创建一个发起转码任务的任务流模板

创建一个名为“我的一个任务流”的任务流模板,任务流转码20,30,40三种格式。

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProcedureTemplate
<公共请求参数>

{
    "MediaProcessTask": {
        "TranscodeTaskSet": [
            {
                "Definition": 30
            },
            {
                "Definition": 20
            },
            {
                "Definition": 40
            }
        ]
    },
    "Name": "我的一个任务流"
}

输出示例

{
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

示例4 创建一个发起转码和采样截图任务的任务流模板

创建一个名为“我的一个任务流”的任务流模板,转出20,30,40三种格式,同时还对视频做采样截图,使用的采样截图的模板 ID 是10。

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProcedureTemplate
<公共请求参数>

{
    "MediaProcessTask": {
        "TranscodeTaskSet": [
            {
                "Definition": 30
            },
            {
                "Definition": 20
            },
            {
                "Definition": 40
            }
        ],
        "SampleSnapshotTaskSet": [
            {
                "Definition": 10
            }
        ]
    },
    "Name": "我的一个任务流"
}

输出示例

{
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.InvalidVodUser 没有开通点播业务。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.ExistedProcedureName 任务流模板名字已存在。
InvalidParameterValue.SubAppId 参数值错误:应用 ID。
LimitExceeded 超过配额限制。
UnauthorizedOperation 未授权操作。