Use StartWorkflow to submit a workflow task - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Operation description

Currently, only Intelligent Media Services (IMS) media assets and ApsaraVideo VOD media assets are supported as workflow inputs.
When you initiate a workflow task, specify a workflow template. You can create a workflow template in the Intelligent Media Services console or use a preset template.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:StartWorkflow

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorkflowId	string	Yes	The workflow template ID. You can view the template ID in the Intelligent Media Services console by navigating to Configuration Management > Workflow Template.	****f0e54971ecbffd472190****
TaskInput	string	No	The workflow input. Currently, media asset types and OSS files are supported. Type: the supported media object type. Valid values: OSS: an OSS file. Media: a media asset ID. Media: the media value. Valid values: If Type is set to OSS, the value is a URL that supports the OSS protocol and HTTP protocol. If Type is set to Media, the value is a media asset ID.	{ "Type": "Media", "Media": "****30706071edbfe290b488****" } or { "Type": "OSS", "Media": "oss://bucket.oss-ap-southeast-1.aliyuncs.com/A/B/C/test1.flv" }
UserData	string	No	The custom settings in JSON format. The maximum length is 512 bytes. Custom callback URL configuration is supported.	{"NotifyAddress":"https://xx.xx.xxx"} or {"NotifyAddress":"ice-callback-demo"}
SkipInputVerification	boolean	No	Specifies whether to skip the input path verification for the workflow. This parameter takes effect only when the workflow input is an OSS file. We recommend that you do not skip the verification to avoid errors caused by incorrect paths. If this parameter is not specified, the default value is false. Valid values: true: Skip the verification. false: Do not skip the verification.	false

Workflow trigger matching rules

When an OSS file triggers a workflow, the rule matching execution policy is as follows: based on the path of the newly added file, the system checks the location bound to the workflow. If the path of the newly added file contains the string bound to the rule, the rule is matched. Otherwise, the rule is not matched. For example, for http://bucket.oss-ap-southeast-1.aliyuncs.com/A/B/C/test1.flv, the rules are:

1. http://bucket.oss-ap-southeast-1.aliyuncs.com/A/B/C/          Matched
2. http://bucket.oss-ap-southeast-1.aliyuncs.com/A/B/            Matched
3. http://bucket.oss-ap-southeast-1.aliyuncs.com/A/              Matched
4. http://bucket.oss-ap-southeast-1.aliyuncs.com/                Matched
5. http://bucket.oss-ap-southeast-1.aliyuncs.com/A/B/C/test.flv  Matched
6. http://bucket.oss-ap-southeast-1.aliyuncs.com/A/B/CC/         Not matched
7. http://bucket.oss-ap-southeast-1.aliyuncs.com/A/B2/           Not matched
8. http://bucket.oss-ap-southeast-1.aliyuncs.com/A2/B/C/         Not matched

Note

When you create a media workflow, do not configure the input path of one workflow as a prefix of the input path of another workflow. Otherwise, a single incremental file triggers two workflow execution instances. For example, if the input paths of two workflows are configured as test and test1 respectively, a file uploaded to the test1 folder also matches the test prefix, which triggers two workflow execution instances.

Matching file name extensions

The trigger requires multimedia files. The media library service determines file types based on file name extensions. A file either has no file name extension (the file name does not contain the extension separator ".") or has a file name extension that conforms to the following rules:

Note

For SWF files, the quality of screenshot and transcoding services is not guaranteed.

Type	Extensions
Video	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
Audio	aac, ac3, acm, amr, ape, caf, flac, m4a, mp3, ra, wav, wma, aiff

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	****42-E8E1-4FBB-8E52-F4225C****
TaskId	string	The workflow task ID.	****22dad741d086a50325f9****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.