SearchPipeline - - Centre de documentation Alibaba Cloud

Recherche les pipelines par état.

Description de l'opération

Cette opération recherche les files d'attente MPS par état. Si vous ne spécifiez pas d'état, l'opération recherche toutes les files d'attente MPS par défaut.

Limites de QPS

La limite de requêtes par seconde (QPS) pour cette opération est de 100 pour chaque utilisateur. Si vous dépassez cette limite, vos appels d'API sont limités, ce qui peut affecter votre activité. Planifiez vos appels en conséquence. Pour plus d'informations, consultez Limites de QPS.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

mts:SearchPipeline

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
PageSize	integer	Non	Le nombre d'entrées à retourner sur chaque page pour une requête paginée. Valeur maximale : 100. Valeur par défaut : 10.	10
PageNumber	integer	Non	Le numéro de page actuel. Valeur par défaut : 1.	1
State	string	Non	L'état des files d'attente MPS à rechercher. Si vous laissez ce paramètre vide, toutes les files d'attente MPS sont recherchées par défaut. All : Toutes les files d'attente MPS. Active : La file d'attente MPS est active. Paused : La file d'attente MPS est en pause. Valeur par défaut : All.	Paused

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
TotalCount	integer	Le nombre total d'entrées.	1
PageSize	integer	Le nombre d'entrées par page.	10
RequestId	string	L'identifiant de la requête.	338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5
PageNumber	integer	Le numéro de page actuel.	1
PipelineList	object
Pipeline	array<object>	La liste des pipelines.
	array<object>	Les détails de la file d'attente MPS.
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

Exemples

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"
      }
    ]
  }
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.