All Products
Search
Document Center

ApsaraVideo Media Processing:QueryMediaWorkflowExecutionList

Last Updated:Mar 03, 2024

Queries media workflow execution instances.

Operation description

  • You can call this operation to query a maximum of 10 media workflow execution instances at a time.
  • Before you call this operation, make sure that the workflow pipeline is enabled. Otherwise, the workflow may not run as expected. For example, the following exceptions may occur: the workflow node is invalid and jobs created in the workflow cannot be executed.

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
RunIdsstringYes

The IDs of the media workflow execution instances. To obtain the instance ID, log on to the ApsaraVideo Media Processing (MPS) console and choose Workflows > Execution Instances in the left-side navigation pane. Separate multiple IDs with commas (,). You can query a maximum of 10 media workflow execution instances at a time.

48e33690ac19445488c706924321****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

NonExistRunIdsarray

The IDs of the execution instances that do not exist.

string

The IDs of the execution instances that do not exist. null is returned if all specified execution instances exist.

null
MediaWorkflowExecutionListobject []

The details of the media workflows.

CreationTimestring

The time when the media workflow was created.

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

The ID of the media workflow.

93ab850b4f6f44eab54b6e91****81d4
Statestring

The status of the media workflow. Valid values:

  • Running: The media workflow is running.
  • Completed: The media workflow is complete.
Note Completed only indicates that the media workflow is complete. View the status of each method in the workflow, such as the transcode and snapshot methods, to check whether the method is called.
  • Fail: The media workflow fails.
Completed
ActivityListobject []

The methods that are called in the media workflow.

EndTimestring

The time when the method ends.

2016-04-01T06:53:44Z
Typestring

The methods that are supported in the media workflow. Valid values: Start, Snapshot, Transcode, Analysis, and Report. For more information, see Methods supported for media workflows.

Start
StartTimestring

The time when the method is called.

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

The status of the workflow method. Valid values:

  • Running: The method is being called.
  • Success: The method is called.
  • Fail: The method failed to be called.
  • Skipped: The method is skipped.
Note For example, after the analysis is complete, the transcode method is called and high-definition and standard-definition transcoding jobs are created. The system determines whether to run the jobs based on the analysis result. If the resolution of the input video is low, the high-definition transcoding job may be skipped.
Running
JobIdstring

The IDs of the jobs that are generated when the methods are called, such as the job IDs for the analysis, transcode, and snapshot methods.

2376030d9d0849399cd20e20f4f3****
Codestring

The error code.

  • This parameter is returned only if Fail is returned for the State parameter.
  • This parameter is not returned if the method status is Success.
InvalidParameter.ResourceContentBad
Messagestring

The error message.

  • This parameter is returned only if Fail is returned for the State parameter.
  • This parameter is not returned if the method status is Success.
The resource operated InputFile is bad
Namestring

The name of the method.

Note The name of each method in a media workflow is unique.
Start
MNSMessageResultobject

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

MessageIdstring

The ID of the message that indicates the MNS message is sent. This parameter is not returned if the MNS message fails to be sent.

4f3bc83233de4e2f81c7dade443e****
ErrorMessagestring

The error message returned if the MNS message fails to be sent. This parameter is not returned if the MNS message is sent.

MessageConfigEmpty
ErrorCodestring

The error code returned if the MNS message fails to be sent. This parameter is not returned if the MNS message is sent.

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

The name of the media workflow.

example-mediaworkflow-****
Inputobject

The input data of the media workflow.

UserDatastring

The user-defined data.

example data ****
InputFileobject

The input file of the media workflow.

Objectstring

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

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

The ID of the OSS region in which the input file resides.

mps-cn-shanghai
Bucketstring

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

example-bucket-****
MediaIdstring

The ID of the media asset. 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

Examples

Sample success responses

JSONformat

{
  "NonExistRunIds": {
    "RunId": [
      "null"
    ]
  },
  "MediaWorkflowExecutionList": {
    "MediaWorkflowExecution": [
      {
        "CreationTime": "016-04-01T06:53:43Z",
        "MediaWorkflowId": "93ab850b4f6f44eab54b6e91****81d4",
        "State": "Completed",
        "ActivityList": {
          "Activity": [
            {
              "EndTime": "2016-04-01T06:53:44Z",
              "Type": "Start",
              "StartTime": "2016-04-01T06:53:44Z",
              "State": "Running",
              "JobId": "2376030d9d0849399cd20e20f4f3****",
              "Code": "InvalidParameter.ResourceContentBad",
              "Message": "The resource operated InputFile is bad",
              "Name": "Start",
              "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": "mps-cn-shanghai",
            "Bucket": "example-bucket-****"
          }
        },
        "MediaId": "512046582a924698a41e0f8b0d2b****",
        "RunId": "48e33690ac19445488c706924321****"
      }
    ]
  },
  "RequestId": "D1D5C080-8E2F-5030-8AB4-13092F17631B"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history