All Products
Search
Document Center

Intelligent Media Services:StartWorkflow

Last Updated:Dec 16, 2024

Submits a workflow task. You can submit a workflow task to implement automated media processing based on a workflow template.

Operation description

  • Only media assets from Intelligent Media Services (IMS) or ApsaraVideo VOD can be used as the input of a workflow.
  • When you submit a workflow task, you must specify a workflow template. You can create a workflow template in the IMS console or use a preset workflow template.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ice:StartWorkflowcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
WorkflowIdstringYes

The ID of the workflow template. To view the template ID, log on to the IMS console and choose Configurations > Workflow Template.

******f0e54971ecbffd472190******
TaskInputstringNo

The workflow input. Only media assets are supported.

{ "Type": "Media", "Media": "******30706071edbfe290b488******" }
UserDatastringNo

The user-defined data in the JSON format, which cannot be up to 512 bytes in length. You can specify a custom callback URL. For more information, see Configure a callback upon editing completion.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

******42-E8E1-4FBB-8E52-F4225C******
TaskIdstring

The ID of the workflow task.

******22dad741d086a50325f9******

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history