Query media workflows using QueryMediaWorkflowList - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

Queries the details of registered media workflows by their IDs.

Operation description

A single request can query up to 10 media workflows.

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:QueryMediaWorkflowList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaWorkflowIds	string	Yes	The IDs of the media workflows to query. To obtain the workflow IDs, log on to the ApsaraVideo Media Processing (MPS) console and choose Workflows > Workflow Settings in the left-side navigation pane. You can query up to 10 media workflows at a time. Separate multiple IDs with commas (,).	93ab850b4f6f44eab54b6e9181d4**,72dfa5e679ab4be9a3ed9974c736**

Response elements

Element	Type	Description	Example
	object	The response parameters.
NonExistMediaWorkflowIds	object
MediaWorkflowId	array	The workflows that do not exist.
	string	The IDs of the media workflows that do not exist. Not returned if all specified workflows are found.	72dfa5e679ab4be9a3ed9974c736****
MediaWorkflowList	object
MediaWorkflow	array<object>	The media workflows.
	object	The detailed information about each media workflow.
CreationTime	string	The time when the media workflow was created.	2016-04-01T05:29:38Z
MediaWorkflowId	string	The ID of the media workflow.	93ab850b4f6f44eab54b6e9181d4****
State	string	The state of the media workflow. Valid values: Inactive: The workflow is deactivated. Active: The workflow is activated. Deleted: The workflow is deleted.	Active
TriggerMode	string	The trigger mode of the media workflow. Valid values: OssAutoTrigger: The workflow is automatically triggered. NotInAuto: The workflow is not automatically triggered.	OssAutoTrigger
Name	string	The name of the media workflow.	example-mediaworkflow-****
Topology	string	The topology of the media workflow.	{mediaworkflow","State":"Active","Topology":"{\"Activities\":{\"Act-Start\":{\"Parameters\":{\"PipelineId\":\"130266f58161436a80bf07cb12c8**\",\"InputFile\":\"{\\\"Bucket\\\": \\\"example-bucket-\\\",\\\"Location\\\": \\\"cn-shanghai\\\"}\"},\"Type\":\"Start\"},\"Act-Report\":{\"Parameters\":{},\"Type\":\"Report\"},\"Act-Transcode-M3U8\":{\"Parameters\":{\"Outputs\":\"[{\\\"Object\\\":\\\"transcode/{ObjectPrefix}{FileName}\\\",\\\"TemplateId\\\": \\\"957d1719ee85ed6527b90cf62726\\\"}]\",\"OutputBucket\":\"example-bucket-\",\"OutputLocation\":\"cn-shanghai\"},\"Type\":\"Transcode\"}},\"Dependencies\":{\"Act-Start\":[\"Act-Transcode-M3U8\"],\"Act-Report\":[],\"Act-Transcode-M3U8\":[\"Act-Report\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d**"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}
RequestId	string	The ID of the request.	16CD0CDD-457E-420D-1234-8385075A618B

Examples

Success response

JSON format

{
  "NonExistMediaWorkflowIds": {
    "MediaWorkflowId": [
      "72dfa5e679ab4be9a3ed9974c736****"
    ]
  },
  "MediaWorkflowList": {
    "MediaWorkflow": [
      {
        "CreationTime": "2016-04-01T05:29:38Z",
        "MediaWorkflowId": "93ab850b4f6f44eab54b6e9181d4****",
        "State": "Active",
        "TriggerMode": "OssAutoTrigger",
        "Name": "example-mediaworkflow-****",
        "Topology": "{mediaworkflow\",\"State\":\"Active\",\"Topology\":\"{\\\"Activities\\\":{\\\"Act-Start\\\":{\\\"Parameters\\\":{\\\"PipelineId\\\":\\\"130266f58161436a80bf07cb12c8****\\\",\\\"InputFile\\\":\\\"{\\\\\\\"Bucket\\\\\\\": \\\\\\\"example-bucket-****\\\\\\\",\\\\\\\"Location\\\\\\\": \\\\\\\"cn-shanghai\\\\\\\"}\\\"},\\\"Type\\\":\\\"Start\\\"},\\\"Act-Report\\\":{\\\"Parameters\\\":{},\\\"Type\\\":\\\"Report\\\"},\\\"Act-Transcode-M3U8\\\":{\\\"Parameters\\\":{\\\"Outputs\\\":\\\"[{\\\\\\\"Object\\\\\\\":\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\",\\\\\\\"TemplateId\\\\\\\": \\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\"}]\\\",\\\"OutputBucket\\\":\\\"example-bucket-****\\\",\\\"OutputLocation\\\":\\\"cn-shanghai\\\"},\\\"Type\\\":\\\"Transcode\\\"}},\\\"Dependencies\\\":{\\\"Act-Start\\\":[\\\"Act-Transcode-M3U8\\\"],\\\"Act-Report\\\":[],\\\"Act-Transcode-M3U8\\\":[\\\"Act-Report\\\"]}}\",\"MediaWorkflowId\":\"93ab850b4f6f44eab54b6e91d24d****\"}]},\"RequestId\":\"16CD0CDD-457E-420D-9755-8385075A1234\"}"
      }
    ]
  },
  "RequestId": "16CD0CDD-457E-420D-1234-8385075A618B"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.