All Products
Search
Document Center

ApsaraVideo Media Processing:SearchMediaWorkflow

Last Updated:Mar 29, 2024

Queries media workflows in the specified state.

Operation description

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.

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizelongNo

The number of entries to return on each page.

  • A maximum of 100 entries can be returned on each page.
  • Default value: 10.
10
PageNumberlongNo

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

1
StateListstringNo

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.
Inactive,Active,Deleted

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountlong

The total number of entries returned.

1
MediaWorkflowListobject []

The details of the media workflows.

CreationTimestring

The time when the media workflow was created.

2016-04-01T05:38:41Z
MediaWorkflowIdstring

The ID of the media workflow.

88c6ca184c0e4578645b665e2a12****
Statestring

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.
Active
TriggerModestring

The trigger mode of the media workflow. Valid values:

  • OssAutoTrigger: The media workflow is automatically triggered.
  • NotInAuto: The media workflow is not automatically triggered.
OssAutoTrigger
Namestring

The name of the media workflow.

example-mediaworkflow-****
Topologystring

The topology of the media workflow.

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

The number of entries returned on each page.

10
RequestIdstring

The ID of the request.

16CD0CDD-457E-420D-9755-8385075A1234
PageNumberlong

The page number of the returned page.

1

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "MediaWorkflowList": {
    "MediaWorkflow": [
      {
        "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 Service error codes.

Change history

Change timeSummary of changesOperation
No change history