Queries media workflows that have been registered.

Usage notes

You can call this operation to query up to 10 media workflows at a time.

Limits on QPS

You can call this operation up to 100 times per second. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes QueryMediaWorkflowList

The operation that you want to perform. Set the value to QueryMediaWorkflowList.

MediaWorkflowIds String Yes 93ab850b4f6f44eab54b6e9181d4****,72dfa5e679ab4be9a3ed9974c736****

The IDs of the media workflows that you want to query. To obtain the IDs of the media workflows, you can 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 of media workflows with commas (,).

Response parameters

Parameter Type Example Description
NonExistMediaWorkflowIds Array of String 72dfa5e679ab4be9a3ed9974c736****

The media workflow IDs that do not exist. This parameter is not returned if all specified media workflows are found.

MediaWorkflowList Array of MediaWorkflow

The details of the media workflows.

MediaWorkflow
CreationTime String 2016-04-01T05:29:38Z

The time when the media workflow was created.

MediaWorkflowId String 93ab850b4f6f44eab54b6e9181d4****

The ID of the media workflow.

State String Active

The status of the media workflow. Valid values:

  • Inactive: The media workflow is deactivated.
  • Active: The media workflow is activated.
  • Deleted: The media workflow is deleted.
TriggerMode String OssAutoTrigger

The trigger mode of the media workflow. Valid values:

  • OssAutoTrigger: The media workflow is automatically triggered.
  • NotInAuto: The media workflow is not automatically triggered.
Name String example-mediaworkflow-****

The name of the media workflow.

Topology String {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"}

The topology of the media workflow.

RequestId String 16CD0CDD-457E-420D-1234-8385075A618B

The ID of the request.

Examples

Sample requests

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=QueryMediaWorkflowList
&MediaWorkflowIds=93ab850b4f6f44eab54b6e9181d4****,72dfa5e679ab4be9a3ed9974c736****
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryMediaWorkflowListResponse>
    <NonExistMediaWorkflowIds>72dfa5e679ab4be9a3ed9974c736****</NonExistMediaWorkflowIds>
    <MediaWorkflowList>
        <CreationTime>2016-04-01T05:29:38Z</CreationTime>
        <MediaWorkflowId>93ab850b4f6f44eab54b6e9181d4****</MediaWorkflowId>
        <State>Active</State>
        <TriggerMode>OssAutoTrigger</TriggerMode>
        <Name>example-mediaworkflow-****</Name>
        <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"}</Topology>
    </MediaWorkflowList>
    <RequestId>16CD0CDD-457E-420D-1234-8385075A618B</RequestId>
</QueryMediaWorkflowListResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NonExistMediaWorkflowIds" : [ "72dfa5e679ab4be9a3ed9974c736****" ],
  "MediaWorkflowList" : [ {
    "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

For a list of error codes, visit the API Error Center.