Use QueryPipelineList to query pipelines - ApsaraVideo Media Processing

Query pipelines by pipeline ID.

Operation description

You can query up to 10 pipelines in a single request.
If the return value is "Code": "InvalidIdentity.ServiceDisabled", "Message": "The request identity was not allowed to operate.", "Recommend", verify that your MPS permissions are configured correctly (ensure the AliyunMTSDefaultRole role is granted) and confirm that your account has no overdue payments.

QPS limit

The QPS limit for this API is 100 requests per second per user. Exceeding this limit triggers rate limiting and may affect your business. Call this API only as needed. For more information, see QPS limit.

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:QueryPipelineList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PipelineIds	string	Yes	A comma-separated list of pipeline IDs to query. Find these IDs in the MPS console > Global Settings > Pipelines. Specify up to 10 IDs, separated by commas (,).	d1ce4d3efcb549419193f50f1fcd**,72dfa5e679ab4be9a3ed9974c736**

Response elements

Element	Type	Description	Example
	object	Response parameters.
RequestId	string	The request ID.	1C538EAA-ACAF-5AD8-B091-A72C63007149
PipelineList	object
Pipeline	array<object>	The list of pipelines.
	array<object>	Response parameters.
Speed	string	The pipeline type. Default value: Standard. Valid values: Boost: accelerated transcoding pipeline. Standard: standard pipeline. NarrowBandHDV2: Narrowband HD 2.0 pipeline. AIVideoCover: intelligent screenshot pipeline. AIVideoFPShot: video DNA pipeline. AIVideoCensor: automated review pipeline. AIVideoMCU: DataQ - Smart Tag Service pipeline. AIVideoSummary: video synopsis pipeline. AIVideoPorn: pornography detection pipeline. AIAudioKWS: audio keyword recognition pipeline. AIAudioASR: speech-to-text pipeline.	Standard
State	string	The pipeline status. Active: The pipeline is enabled. Paused: The pipeline is paused.	Paused
SpeedLevel	integer	The pipeline level.	2
NotifyConfig	object	Alibaba Cloud MNS notification configuration.
MqTopic	string	The message queue that receives messages.	example1,example2
QueueName	string	The queue name created in Alibaba Cloud Simple Message Queue (formerly MNS).	example-queue-****
MqTag	string	The tag.	mts-test
Topic	string	The topic name 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 pipeline name.	example-pipeline-****
Id	string	The pipeline ID.	d1ce4d3efcb549419193f50f1fcd****
QuotaAllocate	integer	The pipeline quota allocation.	10
ExtendConfig	object
IsBoostNew	boolean
MaxMultiSpeed	integer
MultiSpeedDowngradePolicy	string
NonExistPids	object
String	array	The list of non-existent pipeline IDs.
	string	The list of non-existent pipeline IDs. This parameter is not returned if no such IDs exist. Note If this parameter appears despite correct pipeline IDs, verify the UID in your request matches the pipeline owner's UID.	72dfa5e679ab4be9a3ed9974c736****

Examples

Success response

JSON format

{
  "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": false,
          "MaxMultiSpeed": 0,
          "MultiSpeedDowngradePolicy": ""
        }
      }
    ]
  },
  "NonExistPids": {
    "String": [
      "72dfa5e679ab4be9a3ed9974c736****"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.