All Products
Search
Document Center

ApsaraVideo Media Processing:SearchPipeline

Last Updated:Mar 03, 2024

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

Operation description

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.

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
StatestringNo

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

  • All: queries all MPS queues.
  • Active: queries the MPS queues that are active.
  • Paused: queues the MPS queues that are paused.
  • Default value: All.
Paused

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountlong

The total number of entries returned.

1
PageSizelong

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5
PageNumberlong

The page number of the returned page.

1
PipelineListobject []

The MPS queues.

Speedstring

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
Standard
Statestring

The state of the MPS queue. Valid values:

  • Active: The MPS queue is active.
  • Paused: The MPS queue is paused.
Paused
SpeedLevellong

The level of the MPS queue.

1
NotifyConfigobject

The Message Service (MNS) configuration.

MqTopicstring

The queue of messages that are received.

example1,example2
QueueNamestring

The name of the queue that is created in MNS.

example-queue-****
MqTagstring

The tags.

mts-test
Topicstring

The name of the topic that is created in MNS.

example-topic-****
Rolestring

The role that is assigned to the current RAM user.

AliyunMTSDefaultRole
Namestring

The name of the MPS queue.

example-pipeline-****
Idstring

The ID of the MPS queue.

d1ce4d3efcb549419193f50f1fcd****
QuotaAllocatelong

The quota that is allocated to the MPS queue.

10

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5",
  "PageNumber": 1,
  "PipelineList": {
    "Pipeline": [
      {
        "Speed": "Standard",
        "State": "Paused",
        "SpeedLevel": 1,
        "NotifyConfig": {
          "MqTopic": "example1,example2",
          "QueueName": "example-queue-****",
          "MqTag": "mts-test",
          "Topic": "example-topic-****"
        },
        "Role": "AliyunMTSDefaultRole",
        "Name": "example-pipeline-****",
        "Id": "d1ce4d3efcb549419193f50f1fcd****",
        "QuotaAllocate": 10,
        "ExtendConfig": {
          "IsBoostNew": true,
          "MaxMultiSpeed": 0,
          "MultiSpeedDowngradePolicy": ""
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-21The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-07-13The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-06-08The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.