SearchPipeline - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mts:SearchPipeline	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageSize	long	No	The number of entries to return on each page. A maximum of 100 entries can be returned on each page. Default value: 10.	10
PageNumber	long	No	The number of the page to return. Default value: 1.	1
State	string	No	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

Parameter	Type	Description	Example
	object	The response parameters.
TotalCount	long	The total number of entries returned.	1
PageSize	long	The number of entries returned per page.	10
RequestId	string	The ID of the request.	338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5
PageNumber	long	The page number of the returned page.	1
PipelineList	array<object>	The MPS queues.
Pipeline	object	The information about the MPS queue.
Speed	string	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
State	string	The state of the MPS queue. Valid values: Active: The MPS queue is active. Paused: The MPS queue is paused.	Paused
SpeedLevel	long	The level of the MPS queue.	1
NotifyConfig	object	The Message Service (MNS) configuration.
MqTopic	string	The queue of messages that are received.	example1,example2
QueueName	string	The name of the queue that is created in MNS.	example-queue-****
MqTag	string	The tags.	mts-test
Topic	string	The name of the topic that is created in MNS.	example-topic-****
Role	string	The role that is assigned to the current RAM user.	AliyunMTSDefaultRole
Name	string	The name of the MPS queue.	example-pipeline-****
Id	string	The ID of the MPS queue.	d1ce4d3efcb549419193f50f1fcd****
QuotaAllocate	long	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 time	Summary of changes	Operation
2023-09-21	The response structure of the API has changed	View Change Details
2023-07-13	The response structure of the API has changed	View Change Details
2023-06-08	The response structure of the API has changed	View Change Details