All Products
Search
Document Center

ApsaraVideo Media Processing:QueryPipelineList

Last Updated:Mar 03, 2024

Queries ApsaraVideo Media Processing (MPS) queues based on the queue IDs.

Operation description

  • You can call this operation to query up to 10 MPS queues at a time.
  • If "Code": "InvalidIdentity.ServiceDisabled","Message": "The request identity was not allowed operated.","Recommend" is returned after you call this operation, check whether the RAM user that you use is assigned the AliyunMTSDefaultRole role to obtain the permissions on MPS and whether your Alibaba Cloud account has overdue payments.

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
PipelineIdsstringYes

The IDs of the MPS queues that you want to query. To view the IDs, you can log on to the MPS console and choose Global Settings > Pipelines in the left-side navigation pane. You can query up to 10 MPS queues at a time. Separate multiple IDs of MPS queues with commas (,).

d1ce4d3efcb549419193f50f1fcd****,72dfa5e679ab4be9a3ed9974c736****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

1C538EAA-ACAF-5AD8-B091-A72C63007149
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.

2
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 tag string.

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
NonExistPidsarray

The IDs of MPS queues that do not exist.

string

The MPS queue IDs that do not exist. This parameter is not returned if all specified MPS queues are found.

Note This parameter is returned if the specified MPS queue IDs that do not exist are valid. Check whether the user ID (UID) that is used to submit the request is the same as the UID to which the queues belong.
72dfa5e679ab4be9a3ed9974c736****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1C538EAA-ACAF-5AD8-B091-A72C63007149",
  "PipelineList": {
    "Pipeline": [
      {
        "Speed": "Standard",
        "State": "Paused",
        "SpeedLevel": 2,
        "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": ""
        }
      }
    ]
  },
  "NonExistPids": {
    "String": [
      "72dfa5e679ab4be9a3ed9974c736****"
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history