重设工作流

最近更新时间:2024-07-16 01:21:23

我的收藏

1. 接口描述

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

重新设置一个已经存在且处于禁用状态的工作流。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ResetWorkflow。
Version String 公共参数,本接口取值:2019-06-12。
Region String 公共参数,本接口不需要传递此参数。
WorkflowId Integer 工作流 ID。
示例值:10
WorkflowName String 工作流名称,最多128字符。同一个用户该名称唯一。
示例值:“”
Trigger WorkflowTrigger 工作流绑定的触发规则,当上传视频命中该规则到该对象时即触发工作流。
OutputStorage TaskOutputStorage 视频处理的文件输出配置。不填则继承 Trigger 中的存储位置。
OutputDir String 视频处理生成的文件输出的目标目录,必选以 / 开头和结尾,如/movie/201907/
如果不填,表示与触发文件所在的目录一致,即{inputDir}
MediaProcessTask MediaProcessTaskInput 视频处理类型任务参数。
AiContentReviewTask AiContentReviewTaskInput 视频内容审核类型任务参数。
AiAnalysisTask AiAnalysisTaskInput 视频内容分析类型任务参数。
AiRecognitionTask AiRecognitionTaskInput 视频内容识别类型任务参数。
TaskPriority Integer 工作流的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
TaskNotifyConfig TaskNotifyConfig 任务的事件通知信息,不填代表不获取事件通知。

3. 输出参数

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

4. 示例

示例1 重设转码规则

重设工作流 ID 为2573的转码规则,转码输出加上水印。

输入示例

https://mps.tencentcloudapi.com/?Action=ResetWorkflow
&WorkflowId=2573
&WorkflowName=trans-100020-100030-100040
&Trigger.Type=CosFileUpload
&Trigger.CosFileUploadTrigger.Bucket=TopRankVideo-125xxx88
&Trigger.CosFileUploadTrigger.Region=ap-chongqing
&Trigger.CosFileUploadTrigger.Dir=/movie/201907/
&MediaProcessTask.TranscodeTaskSet.0.Definition=100020
&MediaProcessTask.TranscodeTaskSet.0.WatermarkSet.0.Definition=12580
&MediaProcessTask.TranscodeTaskSet.1.Definition=100030
&MediaProcessTask.TranscodeTaskSet.1.WatermarkSet.0.Definition=12580
&MediaProcessTask.TranscodeTaskSet.2.Definition=100040
&MediaProcessTask.TranscodeTaskSet.2.WatermarkSet.0.Definition=12580
&<公共请求参数>

输出示例

{
    "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.InvalidMpsUser 操作失败:非法 mps 用户。
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound.TemplateNotExist 资源不存在:模板不存在。