All Products
Search
Document Center

ApsaraVideo Media Processing:ListMediaWorkflowExecutions

Last Updated:Mar 03, 2024

Queries the execution instances of a media workflow.

Operation description

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

QPS limit

You can call this operation up to 100 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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
MediaWorkflowIdstringNo

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.

43b7335a4b1d4fe883670036affb****
MediaWorkflowNamestringNo

The name of the media workflow. To obtain the workflow name, you can log on to the MPS console and choose Workflows > Workflow Settings.

example-mediaworkflow-****
InputFileURLstringNo

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. For more information, see URL encoding.

http://example-****.cn-hangzhou.aliyuncs.com/test****.flv
NextPageTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. The value is a UUID that contains 32 characters. 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.

39f8e0bc005e4f309379701645f4****
MaximumPageSizelongNo

The maximum number of media workflow execution instances to return. Valid values: [1,100]. Default value: 10.

1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

MediaWorkflowExecutionListobject []

The details of the media workflows.

CreationTimestring

The time when the media workflow was created.

2016-04-01T06:53:43Z
MediaWorkflowIdstring

The ID of the media workflow.

43b7335a4b1d4fe883670036affb****
Statestring

The status of the media workflow. Valid values:

  • running: The execution is in progress.
  • Completed: The execution is complete.
Note A value of Completed indicates that the execution 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 failed.
  • Success: The execution was successful.
Success
ActivityListobject []

The activities that are executed in the media workflow.

EndTimestring

The end time of the activity.

2016-04-01T06:54:00Z
Typestring

The type of the media workflow activity. Valid values: Start, Snapshot, Transcode, Analysis, and Report. For more information, see Methods supported for media workflows.

Start
StartTimestring

The start time of the activity.

2016-04-01T06:53:45Z
Statestring

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.
Success
JobIdstring

The ID of the job generated when the activity is executed. We recommend that you keep this ID for subsequent operation calls.

2376030d9d0849399cd20e20c876****
Codestring

The error code returned if the request failed.

  • The specific error code appears if the state of the activity is Fail.
  • This parameter is not returned if the state of the activity is Success.
null
Messagestring

The error message returned if the request failed.

  • The detailed error message appears if the state of the activity is Fail.
  • This parameter is not returned if the state of the activity is Success.
null
Namestring

The name of the media workflow activity.

Note The name of an activity in a media workflow is unique.
Act-2
MNSMessageResultobject

The message sent by Message Service (MNS) to notify the user of the job result.

MessageIdstring

The ID of the success message. If the job failed, this parameter is not returned.

4f3bc83233de4e2f81c7dade443e****
ErrorMessagestring

The error message returned if the job failed. If the job was successful, this parameter is not returned.

MessageConfigEmpty
ErrorCodestring

The error code returned if the job failed. If the job was successful, this parameter is not returned.

The Topic/Queue config is empty, not send message
Namestring

The name of the media workflow.

example-mediaworkflow-****
Inputobject

The custom data of the media workflow.

UserDatastring

The custom data.

example data
InputFileobject

The information about the storage location of the input file of the media workflow in OSS.

Objectstring

The name of the OSS object that is used as the input media file.

example-mediaWorkflow-****/example-object-****/example.mp4
Locationstring

The OSS region in which the input file resides.

cn-shanghai
Bucketstring

The name of the OSS bucket in which the input media file is stored.

example-bucket-****
MediaIdstring

The ID of the media file. A media file contains all the information about a media workflow.

512046582a924698a41e0f8b0d2b****
RunIdstring

The ID of the execution instance.

48e33690ac19445488c706924321****
RequestIdstring

The ID of the request.

D1D5C080-8E2F-5030-8AB4-13092F17631B
NextPageTokenstring

The returned value of NextPageToken is a pagination token, which can be used in the next request to retrieve a new page of results.

39f8e0bc005e4f309379701645f4****

Examples

Sample success responses

JSONformat

{
  "MediaWorkflowExecutionList": {
    "MediaWorkflowExecution": [
      {
        "CreationTime": "2016-04-01T06:53:43Z",
        "MediaWorkflowId": "43b7335a4b1d4fe883670036affb****",
        "State": "Success",
        "ActivityList": {
          "Activity": [
            {
              "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 Service error codes.

Change history

Change timeSummary of changesOperation
No change history