ListTaskFlowInstance - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. L'outil génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListTaskFlowInstance	Opération à effectuer. Définissez la valeur sur ListTaskFlowInstance.
DagId	Long	Yes	7***	ID du flux de tâches. Appelez l'opération ListTaskFlow ou ListLhTaskFlowAndScenario pour obtenir cet ID.
TriggerType	Integer	No	1	Mode de déclenchement du flux de tâches. Valeurs valides : 0 : Déclenchement automatique basé sur une planification périodique. 1 : Déclenchement manuel.
StartTimeBegin	String	No	2022-01-07	Début de la plage temporelle de recherche des historiques d'exécution. Spécifiez l'heure au format yyyy-MM-DD.
StartTimeEnd	String	No	2022-04-08	Fin de la plage temporelle de recherche des historiques d'exécution. Spécifiez l'heure au format yyyy-MM-DD.
PageIndex	Integer	Yes	1	Numéro de la page à renvoyer.
PageSize	Integer	Yes	20	Nombre d'entrées à renvoyer par page.
Tid	Long	No	3***	ID du locataire (tenant). Appelez l'opération GetUserActiveTenant ou ListUserTenants pour obtenir cet ID.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	8CFF2295-8249-5287-B888-DBD4F0D76CB0	ID de la requête.
ErrorCode	String	UnknownError	Code d'erreur renvoyé en cas d'échec de la requête.
ErrorMessage	String	UnknownError	Message d'erreur renvoyé en cas d'échec de la requête.
Success	Boolean	true	Indique si la requête a abouti. Valeurs valides : true : La requête a abouti. false : La requête a échoué.
DAGInstanceList	Array of DAGInstance		Informations relatives aux historiques d'exécution renvoyés.
DAGInstance
Id	Long	9234	ID de l'historique d'exécution.
BusinessTime	String	2021-11-10 14:37:26	Heure de début d'exécution du flux de tâches, au format yyyy-MM-DD HH:mm:ss.
EndTime	String	2021-11-11 14:38:57	Heure de fin d'exécution du flux de tâches, au format yyyy-MM-DD HH:mm:ss.
DagId	String	7***	ID du flux de tâches.
TriggerType	Integer	1	Mode de déclenchement du flux de tâches. Valeurs valides : 0 : Déclenchement automatique basé sur une planification périodique. 1 : Déclenchement manuel.
Status	Integer	4	État du flux de tâches. Valeurs valides : 0 : En attente de planification. 1 : En cours d'exécution. 2 : En pause. 3 : Échec. 4 : Exécuté. 5 : Terminé.
Message	String	test	Description de la tâche.
HistoryDagId	Long	2****	ID de la version précédemment publiée du flux de tâches.
DagName	String	Spark_SQL_test	Nom du flux de tâches.
OwnerName	String	test_name	Nom du propriétaire du flux de tâches.
DagVersion	String	[]	Version du flux de tâches.
TotalCount	Integer	1	Nombre total d'historiques d'exécution renvoyés.

Exemples

Exemple de requête

http(s)://dms-enterprise.aliyuncs.com/?Action=ListTaskFlowInstance
&DagId=7***
&TriggerType=1
&StartTimeBegin=2022-01-07
&StartTimeEnd=2022-04-08
&PageIndex=1
&PageSize=20
&Tid=3***
&Common request parameters

Exemple de réponse réussie

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTaskFlowInstanceResponse>
    <RequestId>8CFF2295-8249-5287-B888-DBD4F0D76CB0</RequestId>
    <Success>true</Success>
    <DAGInstanceList>
        <Id>9234</Id>
        <BusinessTime>2021-11-10 14:37:26</BusinessTime>
        <EndTime>2021-11-11 14:38:57</EndTime>
        <DagId>7***</DagId>
        <TriggerType>1</TriggerType>
        <Status>4</Status>
        <Message>test</Message>
        <DagName>Spark_SQL_test</DagName>
        <OwnerName>test_name</OwnerName>
    </DAGInstanceList>
    <TotalCount>1</TotalCount>
</ListTaskFlowInstanceResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "8CFF2295-8249-5287-B888-DBD4F0D76CB0",
  "Success" : true,
  "DAGInstanceList" : [ {
    "Id" : 9234,
    "BusinessTime" : "2021-11-10 14:37:26",
    "EndTime" : "2021-11-11 14:38:57",
    "DagId" : "7***",
    "TriggerType" : 1,
    "Status" : 4,
    "Message" : "test",
    "DagName" : "Spark_SQL_test",
    "OwnerName" : "test_name"
  } ],
  "TotalCount" : 1
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre des erreurs d'API.