Query media workflow execution instances using ListMediaWorkflowExecutions - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

Queries execution instances of a media workflow.

Operation description

Only execution instances from the recent 90 days are returned.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you may 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:ListMediaWorkflowExecutions

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaWorkflowId	string	No	The ID of the media workflow. To obtain the workflow ID, log on to the ApsaraVideo Media Processing (MPS) console and choose Workflows > Workflow Settings.	43b7335a4b1d4fe883670036affb****
MediaWorkflowName	string	No	The name of the media workflow. To obtain the workflow name, log on to the MPS console and choose Workflows > Workflow Settings.	example-mediaworkflow-****
InputFileURL	string	No	The Object Storage Service (OSS) URL of the input file. The URL complies with RFC 3986 and is UTF-8 encoded, with reserved characters percent-encoded. For more information, see URL encoding.	http://example-**.cn-hangzhou.aliyuncs.com/test**.flv
NextPageToken	string	No	The pagination token for the next request. The value is a 32-character UUID. Leave this parameter empty for the first request. For subsequent requests, set this to the NextPageToken value returned in the previous response.	39f8e0bc005e4f309379701645f4****
MaximumPageSize	integer	No	The maximum number of execution instances to return. Valid values: `[1,100]`. Default value: 10.	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
MediaWorkflowExecutionList	object
MediaWorkflowExecution	array<object>	The details of media workflow execution instances.
	array<object>	The details of a media workflow execution instance.
CreationTime	string	The time when the media workflow was created.	2016-04-01T06:53:43Z
MediaWorkflowId	string	The ID of the media workflow.	43b7335a4b1d4fe883670036affb****
State	string	The status of the media workflow execution. Valid values: running: The execution is in progress. Completed: The execution is complete. Note A value of Completed indicates that the execution is complete. To check whether each activity (such as Transcode or Snapshot) succeeded, see the status of the individual activity. Fail: The execution failed. Success: The execution was successful.	Success
ActivityList	object
Activity	array<object>	The activities that are executed in the media workflow.
	array<object>	The details of the media workflow activity.
EndTime	string	The end time of the activity.	2016-04-01T06:54:00Z
Type	string	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
StartTime	string	The start time of the activity.	2016-04-01T06:53:45Z
State	string	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, after the analysis activity completes, the system determines which transcoding activity to run based on the analysis result. If the input video resolution is insufficient, the high-definition transcoding activity may be skipped.	Success
JobId	string	The ID of the job generated by the activity. Retain this ID for subsequent API calls.	2376030d9d0849399cd20e20c876****
Code	string	The error code returned if the activity failed. The specific error code is returned when the activity state is Fail. Not returned when the activity state is Success.	null
Message	string	The error message returned if the activity failed. The detailed error message is returned when the activity state is Fail. Not returned when the activity state is Success.	null
Name	string	The name of the media workflow activity. Note The name of an activity in a media workflow is unique.	Act-2
MNSMessageResult	object	The MNS notification message for the job result.
MessageId	string	The ID of the success message. Not returned if the job failed.	4f3bc83233de4e2f81c7dade443e****
ErrorMessage	string	The error message returned if the job failed. Not returned if the job succeeded.	MessageConfigEmpty
ErrorCode	string	The error code returned if the job failed. Not returned if the job succeeded.	The Topic/Queue config is empty, not send message
Name	string	The name of the media workflow.	example-mediaworkflow-****
Input	object	The custom data of the media workflow.
UserData	string	The custom data.	example data
InputFile	object	The OSS storage location of the input file.
Object	string	The name of the OSS object used as the input media file.	example-mediaWorkflow-**/example-object-**/example.mp4
Location	string	The OSS region of the input file.	cn-shanghai
Bucket	string	The name of the OSS bucket that stores the input media file.	example-bucket-****
MediaId	string	The ID of the media file. A media file encapsulates all 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
NextPageToken	string	The returned NextPageToken value, which can be used in the next request to retrieve a new page of results.	39f8e0bc005e4f309379701645f4****

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.