SubmitWorkflowJob

Operation description

Important: Before you call this operation, understand the billing methods and pricing of ApsaraVideo VOD. Using a workflow may incur fees for features such as transcoding, encryption, and content moderation. For more information, see ApsaraVideo VOD pricing.
This operation is an asynchronous API. After you submit the job, the API returns a task ID. The job is queued and runs asynchronously. The service delivers the final result through a callback. You can also query the task status by calling GetTask.
Use this operation to submit a workflow job for a video. For more information about workflows, see Workflows.

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. In the left-side navigation pane, choose Configuration > Media Processing > Workflows to view the ID.	34d577eade633860bdf1237****
MediaId	string	No	The ID of the video. You can obtain the media ID in one of the following ways: Log on to the ApsaraVideo VOD console and choose Media Library > Audio/Video to view the media ID of a video uploaded through the console. If you call the CreateUploadVideo operation to obtain an upload URL and credentials, the media ID is returned as the value of the VideoId parameter in the response. After a video is uploaded, you can call the SearchMedia operation to query the media ID. The media ID is returned as the value of the VideoId parameter in the response.	058b39e75269da42b08f00459****

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	A01C8FF4-C106-4431-418F973DADB7****
TaskId	string	The ID of the workflow job. You can use this ID to check the job status by calling the GetTask operation.

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.