QueryPipelineList -

Usage notes

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	QueryPipelineList	The operation that you want to perform. Set the value to QueryPipelineList.
PipelineIds	String	Yes	d1ce4d3efcb549419193f50f1fcd**,72dfa5e679ab4be9a3ed9974c736**	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 (,).

Response parameters


Parameter	Type	Example	Description
RequestId	String	1C538EAA-ACAF-5AD8-B091-A72C63007149	The ID of the request.
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 state of the MPS queue. Valid values: Active: The MPS queue is active. Paused: The MPS queue is paused.
SpeedLevel	Long	2	The level of the MPS queue.
NotifyConfig	Object		The Message Service (MNS) configuration.
MqTopic	String	example1,example2	The queue of messages that are received.
QueueName	String	example-queue-****	The name of the queue that is created in MNS.
MqTag	String	mts-test	The tags of the messages.
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.
QuotaAllocate	Long	10	The quota that is allocated to the MPS queue.
NonExistPids	Array of String	72dfa5e679ab4be9a3ed9974c736****	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.

Examples

Sample requests

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=QueryPipelineList
&PipelineIds=d1ce4d3efcb549419193f50f1fcd****,72dfa5e679ab4be9a3ed9974c736****
&<Common request parameters>

Sample success responses

XML format

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

<QueryPipelineListResponse>
    <RequestId>1C538EAA-ACAF-5AD8-B091-A72C63007149</RequestId>
    <PipelineList>
        <Speed>Standard</Speed>
        <State>Paused</State>
        <SpeedLevel>2</SpeedLevel>
        <NotifyConfig>
            <MqTopic>example1,example2</MqTopic>
            <QueueName>example-queue-****</QueueName>
            <MqTag>mts-test</MqTag>
            <Topic>example-topic-****</Topic>
        </NotifyConfig>
        <Role>AliyunMTSDefaultRole</Role>
        <Name>example-pipeline-****</Name>
        <Id>d1ce4d3efcb549419193f50f1fcd****</Id>
        <QuotaAllocate>10</QuotaAllocate>
    </PipelineList>
    <NonExistPids>72dfa5e679ab4be9a3ed9974c736****</NonExistPids>
</QueryPipelineListResponse>

JSON format

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

{
  "RequestId" : "1C538EAA-ACAF-5AD8-B091-A72C63007149",
  "PipelineList" : [ {
    "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
  } ],
  "NonExistPids" : [ "72dfa5e679ab4be9a3ed9974c736****" ]
}

Error codes

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