Call SubmitWorkflowJob to start a video processing workflow - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

Before using this operation, make sure that you fully understand the billing methods and pricing of ApsaraVideo VOD. Using workflows may incur fees for transcoding, encryption, automated review, and other services. For more information, see Billing overview.
This operation is an asynchronous operation. After you submit a task, a task ID is returned (the task is not yet complete and enters a background queue for asynchronous execution). The final result is sent through a callback notification. You can also call GetTask to query the task status.
Call this operation to initiate a workflow processing task for a video. For more information about workflows, see Workflow.

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

vod:SubmitWorkflowJob

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorkflowId	string	Yes	The workflow ID. Log on to the ApsaraVideo VOD console and choose Configuration Management > Media Processing > Workflow to view the ID.	34d577eade633860bdf1237****
MediaId	string	No	The media asset ID, which is the video ID. You can obtain the ID by using one of the following methods: For videos uploaded through the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the video ID. When you call the CreateUploadVideo operation to obtain the upload URL and credential, the video ID is the value of the VideoId parameter in the response. After the video is uploaded, you can call the SearchMedia operation to query the video ID, which is the value of the VideoId parameter in the response.	058b39e75269da42b08f00459****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	A01C8FF4-C106-4431-418F973DADB7****
TaskId	string

Examples

Success response

JSON format

{
  "RequestId": "A01C8FF4-C106-4431-418F973DADB7****",
  "TaskId": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.