Query media workflow execution instances by using ListMediaWorkflowExecutions - ApsaraVideo Media Processing

Usage notes

This operation returns execution instances only in the last 90 days.

QPS limit

You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limits.

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	ListMediaWorkflowExecutions	The operation that you want to perform. Set the value to ListMediaWorkflowExecutions.
MediaWorkflowId	String	No	43b7335a4b1d4fe883670036affb****	The ID of the media workflow whose execution instances you want to query. To obtain the workflow ID, you can log on to the ApsaraVideo Media Processing (MPS) console and choose Workflows > Workflow Settings.
MediaWorkflowName	String	No	example-mediaworkflow-****	The name of the media workflow. To obtain the workflow name, you can log on to the MPS console and choose Workflows > Workflow Settings.
InputFileURL	String	No	http://example-**.cn-hangzhou.aliyuncs.com/test**.flv	The Object Storage Service (OSS) URL of the input file of the media workflow. The URL complies with RFC 3986 and is encoded in UTF-8, with reserved characters being percent-encoded.
NextPageToken	String	No	39f8e0bc005e4f309379701645f4****	The token that is used to retrieve the next page of the query results. The value is a 32-bit UUID. When you request the first page of query results, leave the NextPageToken parameter empty. When you request more query results, specify the value of the NextPageToken parameter returned in the query results on the previous page.
MaximumPageSize	Long	No	1	The maximum number of media workflow execution instances to return. Valid values: `[1,100]`. Default value: 10.

Response parameters


Parameter	Type	Example	Description
MediaWorkflowExecutionList	Array of MediaWorkflowExecution		The list of media workflow execution instances.
MediaWorkflowExecution
CreationTime	String	2016-04-01T06:53:43Z	The time when the execution instance was created.
MediaWorkflowId	String	43b7335a4b1d4fe883670036affb****	The ID of the media workflow.
State	String	Success	The status of the execution instance. Valid values: running: The execution instance is in progress. Completed: The execution instance is complete. Note A value of Completed indicates that the execution instance is complete. For the information about whether each activity, such as Transcode or Snapshot, is successful, check the status of the activity. Fail: The execution instance failed. Success: The execution instance was successful.
ActivityList	Array of Activity		The list of activities that are executed in the media workflow.
Activity
EndTime	String	2016-04-01T06:54:00Z	The end time of the activity.
Type	String	Start	The type of the media workflow activity. Valid values: Start, Snapshot, Transcode, Analysis, and Report. For more information, see Media workflow activities.
StartTime	String	2016-04-01T06:53:45Z	The start time of the activity.
State	String	Success	The status of the activity. Valid values: Running: The activity is being executed. Fail: The activity failed to be executed. Skipped: The activity was skipped. Success: The activity was successfully executed. Note For example, the high-definition and standard-definition transcoding activities are to be run after the analysis activity is complete. The system determines the activity to run based on the analysis result. If the definition of the input video content is insufficient, the high-definition transcoding activity may be skipped.
JobId	String	2376030d9d0849399cd20e20c876****	The ID of the job generated when the activity is executed. We recommend that you save this ID for subsequent calls of other operations.
Code	String	null	The error code returned. The specific error code appears if the activity status is Fail. This parameter is not returned if the activity status is Success.
Message	String	null	The error message returned. The detailed error message appears if the activity status is Fail. This parameter is not returned if the activity status is Success.
Name	String	Act-2	The name of the media workflow activity. Note The name of an activity in a media workflow is unique.
MNSMessageResult	Object		The message sent by Message Service (MNS) to notify the user of the job result.
MessageId	String	4f3bc83233de4e2f81c7dade443e****	The ID of the success message. If the job fails, this parameter is not returned.
ErrorMessage	String	MessageConfigEmpty	The error message returned when the job fails. If the job is successful, this parameter is not returned.
ErrorCode	String	The Topic/Queue config is empty, not send message	The error code returned when the job fails. If the job is successful, this parameter is not returned.
Name	String	example-mediaworkflow-****	The name of the media workflow.
Input	Object		The custom data of the media workflow.
UserData	String	example data	The custom data.
InputFile	Object		The information about the storage location of the input file of the media workflow in OSS.
Object	String	example-mediaWorkflow-**/example-object-**/example.mp4	The name of the OSS object that is used as the input file.
Location	String	cn-shanghai	The ID of the OSS region where the input file resides.
Bucket	String	example-bucket-****	The name of the OSS bucket in which the input file is stored.
MediaId	String	512046582a924698a41e0f8b0d2b****	The ID of the media file. This media file ID is associated with all information generated by the media workflow.
RunId	String	48e33690ac19445488c706924321****	The ID of the execution instance.
RequestId	String	D1D5C080-8E2F-5030-8AB4-13092F17631B	The ID of the request.
NextPageToken	String	39f8e0bc005e4f309379701645f4****	The token that is used to retrieve the next page of the query results.

Examples

Sample requests

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=ListMediaWorkflowExecutions
&MediaWorkflowId=43b7335a4b1d4fe883670036affb****
&MediaWorkflowName=example-mediaworkflow-****
&InputFileURL=http://example-****.cn-hangzhou.aliyuncs.com/test****.flv
&NextPageToken=39f8e0bc005e4f309379701645f4****
&MaximumPageSize=1
&<Common request parameters>

Sample success responses

XML format

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

<ListMediaWorkflowExecutionsResponse>
    <MediaWorkflowExecutionList>
        <CreationTime>2016-04-01T06:53:43Z</CreationTime>
        <MediaWorkflowId>43b7335a4b1d4fe883670036affb****</MediaWorkflowId>
        <State>Success</State>
        <ActivityList>
            <EndTime>2016-04-01T06:54:00Z</EndTime>
            <Type>Start</Type>
            <StartTime>2016-04-01T06:53:45Z</StartTime>
            <State>Success</State>
            <JobId>2376030d9d0849399cd20e20c876****</JobId>
            <Code>null</Code>
            <Message>null</Message>
            <Name>Act-2</Name>
            <MNSMessageResult>
                <MessageId>4f3bc83233de4e2f81c7dade443e****</MessageId>
                <ErrorMessage>MessageConfigEmpty</ErrorMessage>
                <ErrorCode>The Topic/Queue config is empty, not send message</ErrorCode>
            </MNSMessageResult>
        </ActivityList>
        <Name>example-mediaworkflow-****</Name>
        <Input>
            <UserData>example data</UserData>
            <InputFile>
                <Object>example-mediaWorkflow-****/example-object-****/example.mp4</Object>
                <Location>cn-shanghai</Location>
                <Bucket>example-bucket-****</Bucket>
            </InputFile>
        </Input>
        <MediaId>512046582a924698a41e0f8b0d2b****</MediaId>
        <RunId>48e33690ac19445488c706924321****</RunId>
    </MediaWorkflowExecutionList>
    <RequestId>D1D5C080-8E2F-5030-8AB4-13092F17631B</RequestId>
    <NextPageToken>39f8e0bc005e4f309379701645f4****</NextPageToken>
</ListMediaWorkflowExecutionsResponse>

JSON format

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

{
  "MediaWorkflowExecutionList" : [ {
    "CreationTime" : "2016-04-01T06:53:43Z",
    "MediaWorkflowId" : "43b7335a4b1d4fe883670036affb****",
    "State" : "Success",
    "ActivityList" : [ {
      "EndTime" : "2016-04-01T06:54:00Z",
      "Type" : "Start",
      "StartTime" : "2016-04-01T06:53:45Z",
      "State" : "Success",
      "JobId" : "2376030d9d0849399cd20e20c876****",
      "Code" : "null",
      "Message" : "null",
      "Name" : "Act-2",
      "MNSMessageResult" : {
        "MessageId" : "4f3bc83233de4e2f81c7dade443e****",
        "ErrorMessage" : "MessageConfigEmpty",
        "ErrorCode" : "The Topic/Queue config is empty, not send message"
      }
    } ],
    "Name" : "example-mediaworkflow-****",
    "Input" : {
      "UserData" : "example data",
      "InputFile" : {
        "Object" : "example-mediaWorkflow-****/example-object-****/example.mp4",
        "Location" : "cn-shanghai",
        "Bucket" : "example-bucket-****"
      }
    },
    "MediaId" : "512046582a924698a41e0f8b0d2b****",
    "RunId" : "48e33690ac19445488c706924321****"
  } ],
  "RequestId" : "D1D5C080-8E2F-5030-8AB4-13092F17631B",
  "NextPageToken" : "39f8e0bc005e4f309379701645f4****"
}

Error codes

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