Queries media workflows in the specified state.

Usage notes

You can call this operation to query media workflows in the specified state. If you do not specify the state, all media workflows are queried by default.

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 SearchMediaWorkflow

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

PageSize Long No 10

The number of entries to return on each page.

  • A maximum of 100 entries can be returned on each page.
  • Default value: 10.
PageNumber Long No 1

The number of the page to return. Default value: 1.

StateList String No Inactive,Active,Deleted

The status of the media workflows that you want to query. You can specify multiple states. Separate multiple states with commas (,). Default value: Inactive,Active,Deleted. Valid values:

  • Inactive: Deactivated media workflows are queried.
  • Active: Activated media workflows are queried.
  • Deleted: Deleted media workflows are queried.

Response parameters

Parameter Type Example Description
TotalCount Long 1

The total number of entries returned.

MediaWorkflowList Array of MediaWorkflow

The details of the media workflows.

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

The time when the media workflow was created.

MediaWorkflowId String 88c6ca184c0e4578645b665e2a12****

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 null

The topology of the media workflow.

PageSize Long 10

The number of entries returned per page.

RequestId String 16CD0CDD-457E-420D-9755-8385075A1234

The ID of the request.

PageNumber Long 1

The page number of the returned page.

Examples

Sample requests

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=SearchMediaWorkflow
&PageSize=10
&PageNumber=1
&StateList=Inactive,Active,Deleted
&<Common request parameters>

Sample success responses

XML format

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

<SearchMediaWorkflowResponse>
    <TotalCount>1</TotalCount>
    <MediaWorkflowList>
        <CreationTime>2016-04-01T05:38:41Z</CreationTime>
        <MediaWorkflowId>88c6ca184c0e4578645b665e2a12****</MediaWorkflowId>
        <State>Active</State>
        <TriggerMode>OssAutoTrigger</TriggerMode>
        <Name>example-mediaworkflow-****</Name>
        <Topology>{"MediaWorkflowList":{"MediaWorkflow":[{"CreationTime":"2016-04-01T05:29:38Z","Name":"example-mediaworkflow-****","State":"Active","Topology":"{\"Activities\":{\"Act-Start\":{\"Parameters\":{\"PipelineId\":\"130266f58161436a80bf07cb12c8****\",\"InputFile\":\"{\\\"Bucket\\\": \\\"example-bucket-****\\\",\\\"Location\\\": \\\"example-location\\\"}\"},\"Type\":\"Start\"},\"Act-Report\":{\"Parameters\":{},\"Type\":\"Report\"},\"Act-Transcode-M3U8\":{\"Parameters\":{\"Outputs\":\"[{\\\"Object\\\":\\\"transcode/{ObjectPrefix}{FileName}\\\",\\\"TemplateId\\\": \\\"957d1719ee85ed6527b90cf62726****\\\"}]\",\"OutputBucket\":\"example-bucket-****\",\"OutputLocation\":\"example-location\"},\"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>
    <PageSize>10</PageSize>
    <RequestId>16CD0CDD-457E-420D-9755-8385075A1234</RequestId>
    <PageNumber>1</PageNumber>
</SearchMediaWorkflowResponse>

JSON format

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

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

Error codes

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