SearchPipeline - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Search for pipelines by status.

Operation description

This operation searches for MPS queues by status. If you do not specify a status, the operation searches all MPS queues by default.

QPS limits

The queries per second (QPS) limit for this operation is 100 for each user. If you exceed this limit, your API calls are throttled, which may affect your business. Plan your calls accordingly. For more information, see QPS limits.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mts:SearchPipeline

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries to return on each page for a paged query. Maximum value: 100. Default value: 10.	10
PageNumber	integer	No	The current page number. Default value: 1.	1
State	string	No	The status of the MPS queues to search for. If you leave this parameter empty, all MPS queues are searched by default. All: All MPS queues. Active: The MPS queue is active. Paused: The MPS queue is paused. Default value: All.	Paused

Response elements

Element	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of entries.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5
PageNumber	integer	The current page number.	1
PipelineList	object
Pipeline	array<object>	The list of pipelines.
	array<object>	The details of the MPS queue.
Speed	string	The type of the MPS queue. Default value: Standard. Valid values: Boost: a high-speed transcoding MPS queue. Standard: a standard MPS queue. NarrowBandHDV2: a Narrowband HD 2.0 MPS queue. AIVideoCover: a smart snapshot MPS queue. AIVideoFPShot: a video DNA MPS queue. AIVideoCensor: an automated review MPS queue. AIVideoMCU: a smart tagging MPS queue. AIVideoSummary: a video synopsis MPS queue. AIVideoPorn: a pornography detection MPS queue. AIAudioKWS: an audio keyword recognition MPS queue. AIAudioASR: a speech-to-text MPS queue.	Standard
State	string	The status of the MPS queue. Valid values: Active: The MPS queue is active. Paused: The MPS queue is paused.	Paused
SpeedLevel	integer	The speed level of the MPS queue.	1
NotifyConfig	object	The MNS notification settings.
MqTopic	string	The topic of the message queue.	example1,example2
QueueName	string	The queue created in Alibaba Cloud Simple Message Queue (formerly MNS).	example-queue-****
MqTag	string	The tag.	mts-test
Topic	string	The topic created in Alibaba Cloud Simple Message Queue (formerly MNS).	example-topic-****
Role	string	The role associated with 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	integer	The quota allocated to the MPS queue.	10
CreationTime	string	The time when the MPS queue was created.	2021-03-04T06:44:43Z

Examples

Success response

JSON format

{
  "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,
        "CreationTime": " 2021-03-04T06:44:43Z"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.