ListMediaWorkflowExecutions - - Centre de documentation Alibaba Cloud

Consulte les instances d'exécution d'un workflow média.

Description de l'opération

Cette opération renvoie uniquement les instances d'exécution des 90 derniers jours.

Limite de QPS

Vous pouvez appeler cette opération jusqu'à 100 fois par seconde et par compte. Les requêtes qui dépassent cette limite sont abandonnées et vous subirez des interruptions de service. Nous vous recommandons de prendre en compte cette limite lors de l'appel de cette opération. Pour plus d'informations, consultez Limite 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:ListMediaWorkflowExecutions

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
MediaWorkflowId	string	Non	L'identifiant du workflow média dont vous souhaitez interroger les instances d'exécution. Pour obtenir l'identifiant du workflow, vous pouvez vous connecter à la console ApsaraVideo Media Processing (MPS) et choisir Workflows > Paramètres de workflow.	43b7335a4b1d4fe883670036affb****
MediaWorkflowName	string	Non	Le nom du workflow média. Pour obtenir le nom du workflow, vous pouvez vous connecter à la console MPS et choisir Workflows > Paramètres de workflow.	example-mediaworkflow-****
InputFileURL	string	Non	L'URL Object Storage Service (OSS) du fichier d'entrée du workflow média. L'URL est conforme à la norme RFC 3986 et est encodée en UTF-8, les caractères réservés étant encodés en pourcentage. Pour plus d'informations, consultez Encodage d'URL.	http://example-**.cn-hangzhou.aliyuncs.com/test**.flv
NextPageToken	string	Non	Le jeton de pagination utilisé dans la requête suivante pour récupérer une nouvelle page de résultats. La valeur est un UUID contenant 32 caractères. Lorsque vous demandez la première page de résultats de requête, laissez le paramètre NextPageToken vide. Lorsque vous demandez d'autres résultats de requête, spécifiez la valeur du paramètre NextPageToken renvoyée dans les résultats de requête de la page précédente.	39f8e0bc005e4f309379701645f4****
MaximumPageSize	integer	Non	Le nombre maximal d'instances d'exécution de workflow média à renvoyer. Valeurs valides : `[1,100]`. Valeur par défaut : 10.	1

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
MediaWorkflowExecutionList	object
MediaWorkflowExecution	array<object>	Les détails des workflows média.
	array<object>	Les détails du workflow média.
CreationTime	string	The time when the media workflow was created.	2016-04-01T06:53:43Z
MediaWorkflowId	string	The ID of the media workflow.	43b7335a4b1d4fe883670036affb****
State	string	The status of the media workflow. Valid values: running: The execution is in progress. Completed: The execution is complete. Remarque A value of Completed indicates that the execution is complete. For the information about whether each activity, such as Transcode or Snapshot, is successful, check the status of the activity. Fail: The execution failed. Success: The execution was successful.	Success
ActivityList	object
Activity	array<object>	The activities that are executed in the media workflow.
	array<object>	The details of the media workflow activity.
EndTime	string	The end time of the activity.	2016-04-01T06:54:00Z
Type	string	The type of the media workflow activity. Valid values: Start, Snapshot, Transcode, Analysis, and Report. For more information, see Methods supported for media workflows.	Start
StartTime	string	The start time of the activity.	2016-04-01T06:53:45Z
State	string	The status of the activity. Valid values: Running: The activity is being executed. Fail: The activity failed to be executed. Skipped: The activity was skipped. Success: The activity was successfully executed. Remarque For example, the high-definition and standard-definition transcoding activities are to be run after the analysis activity is complete. The system determines the activity to run based on the analysis result. If the definition of the input video content is insufficient, the high-definition transcoding activity may be skipped.	Success
JobId	string	The ID of the job generated when the activity is executed. We recommend that you keep this ID for subsequent operation calls.	2376030d9d0849399cd20e20c876****
Code	string	The error code returned if the request failed. The specific error code appears if the state of the activity is Fail. This parameter is not returned if the state of the activity is Success.	null
Message	string	The error message returned if the request failed. The detailed error message appears if the state of the activity is Fail. This parameter is not returned if the state of the activity is Success.	null
Name	string	The name of the media workflow activity. Remarque The name of an activity in a media workflow is unique.	Act-2
MNSMessageResult	object	The message sent by Message Service (MNS) to notify the user of the job result.
MessageId	string	The ID of the success message. If the job failed, this parameter is not returned.	4f3bc83233de4e2f81c7dade443e****
ErrorMessage	string	The error message returned if the job failed. If the job was successful, this parameter is not returned.	MessageConfigEmpty
ErrorCode	string	The error code returned if the job failed. If the job was successful, this parameter is not returned.	The Topic/Queue config is empty, not send message
Name	string	The name of the media workflow.	example-mediaworkflow-****
Input	object	The custom data of the media workflow.
UserData	string	The custom data.	example data
InputFile	object	The information about the storage location of the input file of the media workflow in OSS.
Object	string	The name of the OSS object that is used as the input media file.	example-mediaWorkflow-**/example-object-**/example.mp4
Location	string	The OSS region in which the input file resides.	cn-shanghai
Bucket	string	The name of the OSS bucket in which the input media file is stored.	example-bucket-****
MediaId	string	The ID of the media file. A media file contains all the information about a media workflow.	512046582a924698a41e0f8b0d2b****
RunId	string	The ID of the execution instance.	48e33690ac19445488c706924321****
RequestId	string	L'identifiant de la requête.	D1D5C080-8E2F-5030-8AB4-13092F17631B
NextPageToken	string	La valeur renvoyée de NextPageToken est un jeton de pagination, qui peut être utilisé dans la requête suivante pour récupérer une nouvelle page de résultats.	39f8e0bc005e4f309379701645f4****

Exemples

JSON format

{
  "MediaWorkflowExecutionList": {
    "MediaWorkflowExecution": [
      {
        "CreationTime": "2016-04-01T06:53:43Z",
        "MediaWorkflowId": "43b7335a4b1d4fe883670036affb****",
        "State": "Success",
        "ActivityList": {
          "Activity": [
            {
              "EndTime": "2016-04-01T06:54:00Z",
              "Type": "Start",
              "StartTime": "2016-04-01T06:53:45Z",
              "State": "Success",
              "JobId": "2376030d9d0849399cd20e20c876****",
              "Code": "null",
              "Message": "null",
              "Name": "Act-2",
              "MNSMessageResult": {
                "MessageId": "4f3bc83233de4e2f81c7dade443e****",
                "ErrorMessage": "MessageConfigEmpty",
                "ErrorCode": "The Topic/Queue config is empty, not send message"
              }
            }
          ]
        },
        "Name": "example-mediaworkflow-****",
        "Input": {
          "UserData": "example data",
          "InputFile": {
            "Object": "example-mediaWorkflow-****/example-object-****/example.mp4",
            "Location": "cn-shanghai",
            "Bucket": "example-bucket-****"
          }
        },
        "MediaId": "512046582a924698a41e0f8b0d2b****",
        "RunId": "48e33690ac19445488c706924321****"
      }
    ]
  },
  "RequestId": "D1D5C080-8E2F-5030-8AB4-13092F17631B",
  "NextPageToken": "39f8e0bc005e4f309379701645f4****"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.