创建编排

最近更新时间:2024-03-12 01:41:31

我的收藏

1. 接口描述

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

对 COS 中指定 Bucket 的目录下上传的媒体文件,设置处理规则,包括:

  1. 视频转码(带水印);
  2. 视频转动图;
  3. 对视频按指定时间点截图;
  4. 对视频采样截图;
  5. 对视频截图雪碧图;
  6. 对视频转自适应码流;
  7. 智能内容审核(鉴黄、敏感信息检测);
  8. 智能内容分析(标签、分类、封面、按帧标签);
  9. 智能内容识别(人脸、文本全文、文本关键词、语音全文、语音关键词)。

注意:创建编排成功后是禁用状态,需要手动启用。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateSchedule。
Version String 公共参数,本接口取值:2019-06-12。
Region String 公共参数,本接口不需要传递此参数。
ScheduleName String 编排名称,最多128字符。同一个用户该名称唯一。
示例值:trans-100020-100030-100040
Trigger WorkflowTrigger 编排绑定的触发规则,当上传视频命中该规则到该对象时即触发编排。
Activities.N Array of Activity 编排任务列表。
OutputStorage TaskOutputStorage 媒体处理的文件输出存储位置。不填则继承 Trigger 中的存储位置。
OutputDir String 媒体处理生成的文件输出的目标目录,必选以 / 开头和结尾,如/movie/201907/
如果不填,表示与触发文件所在的目录一致。
示例值:""
TaskNotifyConfig TaskNotifyConfig 任务的事件通知配置,不填代表不获取事件通知。
ResourceId String 资源ID,需要保证对应资源是开启状态。默认为帐号主资源ID。

3. 输出参数

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

4. 示例

示例1 设置转码规则

对名为 evan-test-1300828900 的Bucket 创建编排,当 mp4或者flv文件上传到 /input/ 目录时,触发多次转码任务,转码模板ID为 10。

输入示例

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

{
    "ScheduleName": "evan_test7",
    "Trigger": {
        "Type": "CosFileUpload",
        "CosFileUploadTrigger": {
            "Bucket": "evan-test-1300828900",
            "Region": "ap-guangzhou",
            "Dir": "/input/",
            "Formats": [
                "mp4",
                "flv"
            ]
        }
    },
    "Activities": [
        {
            "ActivityType": "input",
            "ReardriveIndex": [
                1,
                2
            ]
        },
        {
            "ActivityType": "action-trans",
            "ReardriveIndex": [
                3
            ],
            "ActivityPara": {
                "TranscodeTask": {
                    "Definition": 10
                }
            }
        },
        {
            "ActivityType": "action-trans",
            "ReardriveIndex": [
                6,
                7
            ],
            "ActivityPara": {
                "TranscodeTask": {
                    "Definition": 10
                }
            }
        },
        {
            "ActivityType": "action-trans",
            "ReardriveIndex": [
                4,
                5
            ],
            "ActivityPara": {
                "TranscodeTask": {
                    "Definition": 10
                }
            }
        },
        {
            "ActivityType": "action-trans",
            "ReardriveIndex": [
                10
            ],
            "ActivityPara": {
                "TranscodeTask": {
                    "Definition": 10
                }
            }
        },
        {
            "ActivityType": "action-trans",
            "ReardriveIndex": [
                10
            ],
            "ActivityPara": {
                "TranscodeTask": {
                    "Definition": 10
                }
            }
        },
        {
            "ActivityType": "action-trans",
            "ReardriveIndex": [
                10
            ],
            "ActivityPara": {
                "TranscodeTask": {
                    "Definition": 10
                }
            }
        },
        {
            "ActivityType": "action-trans",
            "ReardriveIndex": [
                8
            ],
            "ActivityPara": {
                "TranscodeTask": {
                    "Definition": 10
                }
            }
        },
        {
            "ActivityType": "action-trans",
            "ReardriveIndex": [
                9
            ],
            "ActivityPara": {
                "TranscodeTask": {
                    "Definition": 10
                }
            }
        },
        {
            "ActivityType": "action-trans",
            "ReardriveIndex": [
                10
            ],
            "ActivityPara": {
                "TranscodeTask": {
                    "Definition": 10
                }
            }
        },
        {
            "ActivityType": "output",
            "ActivityPara": {}
        }
    ],
    "OutputStorage": {
        "Type": "COS",
        "CosOutputStorage": {
            "Bucket": "evan-test-1300828900",
            "Region": "ap-nanjing"
        }
    },
    "OutputDir": "output/"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CosStatusInavlid 操作失败:COS 已经停服。
FailedOperation.GenerateResource 生成资源失败。
FailedOperation.InvalidMpsUser 操作失败:非法 mps 用户。
InternalError 内部错误。
InternalError.AccessDBError 数据错误。
InternalError.GenDefinition 内部错误:生成模板 ID 失败。
InvalidParameterValue 参数取值错误。
LimitExceeded.TooMuchTemplate 超过限制值:模板数超限。
ResourceNotFound.CosBucketNameInvalid 资源不存在:Cos bucket 名称无效。
ResourceNotFound.CosBucketNotExist 资源不存在:Cos bucket 不存在。