Queries ApsaraVideo Media Processing (MPS) queues in the specified state.

Usage notes

You can call this operation to query MPS queues in the specified state. If you do not specify the state, all MPS queues 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 SearchPipeline

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

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.

State String No Paused

The status of the MPS queues that you want to query. If you leave this parameter empty, all MPS queues are queried.

  • All: All MPS queues are queried.
  • Active: Active MPS queues are queried.
  • Paused: Paused MPS queues are queried.
  • Default value: All.

Response parameters

Parameter Type Example Description
TotalCount Long 1

The total number of entries returned.

PageSize Long 10

The number of entries returned per page.

RequestId String 338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5

The ID of the request.

PageNumber Long 1

The page number of the returned page.

PipelineList Array of Pipeline

The details of the MPS queues.

Pipeline
Speed String Standard

The type of the MPS queue. Default value: Standard. Valid values:

  • Boost: MPS queue with transcoding speed boosted.
  • Standard: standard MPS queue.
  • NarrowBandHDV2: MPS queue that supports Narrowband HD™ 2.0.
  • AIVideoCover: MPS queue for intelligent snapshot capture.
  • AIVideoFPShot: MPS queue for media fingerprinting.
  • AIVideoCensor: MPS queue for automated review.
  • AIVideoMCU: MPS queue for smart tagging.
  • AIVideoSummary: MPS queue for video synopsis.
  • AIVideoPorn: MPS queue for pornography detection in videos.
  • AIAudioKWS: MPS queue for keyword recognition in audio.
  • AIAudioASR: MPS queue for speech-to-text conversion.
State String Paused

The status of the pipeline. Valid values:

  • Active: The MPS queue is active.
  • Paused: The MPS queue is paused.
NotifyConfig Object

The MNS notification configuration.

QueueName String example-queue-****

The name of the queue that is created in MNS.

Topic String example-topic-****

The name of the topic that is created in MNS.

Role String AliyunMTSDefaultRole

The role that is assigned to the current RAM user.

Name String example-pipeline-****

The name of the MPS queue.

Id String d1ce4d3efcb549419193f50f1fcd****

The ID of the MPS queue.

Examples

Sample requests

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=SearchPipeline
&PageSize=10
&PageNumber=1
&State=Paused
&<Common request parameters>

Sample success responses

XML format 

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

<SearchPipelineResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5</RequestId>
    <PageNumber>1</PageNumber>
    <PipelineList>
        <Speed>Standard</Speed>
        <State>Paused</State>
        <NotifyConfig>
            <QueueName>example-queue-****</QueueName>
            <Topic>example-topic-****</Topic>
        </NotifyConfig>
        <Role>AliyunMTSDefaultRole</Role>
        <Name>example-pipeline-****</Name>
        <Id>d1ce4d3efcb549419193f50f1fcd****</Id>
    </PipelineList>
</SearchPipelineResponse>

JSON format 

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

{
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5",
  "PageNumber" : 1,
  "PipelineList" : [ {
    "Speed" : "Standard",
    "State" : "Paused",
    "NotifyConfig" : {
      "QueueName" : "example-queue-****",
      "Topic" : "example-topic-****"
    },
    "Role" : "AliyunMTSDefaultRole",
    "Name" : "example-pipeline-****",
    "Id" : "d1ce4d3efcb549419193f50f1fcd****"
  } ]
}

Error codes

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