QueryMediaWorkflowExecutionList API Reference - ApsaraVideo MPS - Alibaba Cloud - ApsaraVideo Media Processing

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.

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

mts:QueryMediaWorkflowExecutionList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RunIds	string	Yes	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 elements

Element	Type	Description	Example
	object	The response parameters.
NonExistRunIds	object
RunId	array	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
MediaWorkflowExecutionList	object
MediaWorkflowExecution	array<object>	The details of the media workflows.
	array<object>	The information about the media workflow.
CreationTime	string	The time when the media workflow was created.	016-04-01T06:53:43Z
MediaWorkflowId	string	The ID of the media workflow.	93ab850b4f6f44eab54b6e91****81d4
State	string	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
ActivityList	object
Activity	array<object>	The methods that are called in the media workflow.
	array<object>	The details of the method.
EndTime	string	The time when the method ends.	2016-04-01T06:53:44Z
Type	string	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
StartTime	string	The time when the method is called.	2016-04-01T06:53:44Z
State	string	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
JobId	string	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****
Code	string	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
Message	string	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
Name	string	The name of the method. Note The name of each method in a media workflow is unique.	Start
MNSMessageResult	object	The message sent by Message Service (MNS) to notify the user of the job result.
MessageId	string	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****
ErrorMessage	string	The error message returned if the MNS message fails to be sent. This parameter is not returned if the MNS message is sent.	MessageConfigEmpty
ErrorCode	string	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
Name	string	The name of the media workflow.	example-mediaworkflow-****
Input	object	The input data of the media workflow.
UserData	string	The user-defined data.	example data ****
InputFile	object	The input file of the media workflow.
Object	string	The name of the OSS object that is used as the input file.	example-mediaWorkflow-**/example-object-**/example.mp4
Location	string	The ID of the OSS region in which the input file resides.	mps-cn-shanghai
Bucket	string	The name of the OSS bucket in which the input file is stored.	example-bucket-****
MediaId	string	The ID of the media asset. A media file contains all the information about a media workflow.	512046582a924698a41e0f8b0d2b****
RunId	string	The ID of the execution instance.	48e33690ac19445488c706924321****
RequestId	string	The ID of the request.	D1D5C080-8E2F-5030-8AB4-13092F17631B

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.