Initiates a video-on-demand (VOD) workflow to process media files.

Usage notes

You can call this operation to initiate a VOD workflow to process media files. For more information, see Workflows.

QPS limit

You can call this operation up to 20 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SubmitWorkflowJob

The operation that you want to perform. Set the value to SubmitWorkflowJob.

WorkflowId String Yes 34d577eade633860bdf1237****

The ID of the workflow. To view the ID of the workflow, log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Configuration Management > Media Processing > Workflows.

MediaId String Yes 058b39e75269da42b08f00459****

The ID of the media file. You can use one of the following methods to obtain the ID:

  • Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video. On the Video and Audio page, view the ID of the audio or video file. This method is applicable to files that are uploaded by using the ApsaraVideo VOD console.
  • Obtain the value of the VideoId parameter when you call the CreateUploadVideo operation to upload media files.
  • Obtain the value of the VideoId parameter when you call the SearchMedia operation after you upload media files.

Response parameters

Parameter Type Example Description
RequestId String A01C8FF4-C106-4431-418F973DADB7****

The ID of the request.

Examples

Sample requests

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=SubmitWorkflowJob
&WorkflowId=34d577eade633860bdf1237****
&MediaId=058b39e75269da42b08f00459****
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<SubmitWorkflowJobResponse>
    <RequestId>A01C8FF4-C106-4431-418F973DADB7****</RequestId>
</SubmitWorkflowJobResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.