调用StartWorkflow提交工作流任务_智能媒体服务(IMS)-阿里云帮助中心

通过调用StartWorkflow接口，您可以提交工作流模板任务，从而实现基于工作流模板的自动化媒体处理流程。

接口说明

目前只支持智能媒体服务媒资/视频点播媒资作为工作流输入。
发起工作流任务时，需指定工作流模板，可通过智能媒体服务控制台创建工作流模板，或使用系统预置的工作流模板。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ice:StartWorkflow	create	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
WorkflowId	string	是	工作流模板 ID。您可通过智能媒体服务控制台> 配置管理 > 工作流模板，查看模板 ID。	****f0e54971ecbffd472190****
TaskInput	string	否	工作流输入，目前支持媒资类型和 OSS 文件。 Type，支持的媒体对象类型，取值： OSS：oss 文件 Media：媒资 ID Media，媒体值，取值： type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议。 type 为 Media 时，为媒资 ID。	{ "Type": "Media", "Media": "****30706071edbfe290b488****" }或 { "Type": "OSS", "Media": "oss://bucket/path/to/video.mp4" }
UserData	string	否	自定义设置，Json 格式，长度限制为 512 字节。支持自定义回调地址配置。	{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}
SkipInputVerification	boolean	否	是否跳过工作流支持输入路径的检查，仅当工作流输入为 OSS 文件时有效。此处建议您选择不跳过，避免因路径出错而导致的错误。若缺省，则默认为不跳过检查。取值： true：跳过 false：不跳过	false

工作流触发匹配规则

OSS 文件触发工作流时规则匹配执行策略如下：以新增文件的路径为基础，检查工作流绑定的位置，如果新增文件的路径中包含规则绑定的字符串则匹配，不包含则不匹配。例如：http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test1.flv 规则：

1、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/          匹配
2、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/            匹配
3、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/              匹配
4、http://bucket.oss-cn-hangzhou.aliyuncs.com/                匹配
5、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.flv  匹配
6、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/CC/         不匹配
7、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B2/           不匹配
8、http://bucket.oss-cn-hangzhou.aliyuncs.com/A2/B/C/         不匹配

说明在新增媒体工作流时，请您不要配置一个工作流的输入路径为另外一个工作流的输入路径的前缀，否则会一个增量文件触发两次工作流执行实例。例如：两个工作流的输入路径分别配置 test 和 test1，则当输入文件上传到 test1 文件夹下同样满足 test 前缀，因此会触发两次工作流执行实例。

匹配文件扩展名

触发要求必须是多媒体文件，媒体库服务是通过文件扩展名来判断的。文件或者没有扩展名（文件名中不包含扩展名分割符号“.”），或者扩展名符合下面的规则：

说明对于 swf，截图及转码服务质量不保障。

类型	扩展名
视频	3gp, asf, avi, dat, dv, flv, f4v, gif, m2t, m3u8, m4v, mj2, mjpeg, mkv, mov, mp4, mpe, mpg, mpeg, mts, ogg, qt, rm, rmvb, swf, ts, vob, wmv, webm
音频	aac, ac3, acm, amr, ape, caf, flac, m4a, mp3, ra, wav, wma, aiff

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	****42-E8E1-4FBB-8E52-F4225C****
TaskId	string	工作流任务 ID。	****22dad741d086a50325f9****

示例

正常返回示例

JSON格式

{
  "RequestId": "******42-E8E1-4FBB-8E52-F4225C******",
  "TaskId": "******22dad741d086a50325f9******"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史