ListTaskFlowInstance - - Centro de documentación de Alibaba Cloud

Consulta los registros de ejecución de un flujo de tareas.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListTaskFlowInstance	La operación que desea ejecutar. Establezca el valor en ListTaskFlowInstance.
DagId	Long	Sí	7***	El ID del flujo de tareas. Puede llamar a la operación ListTaskFlow o ListLhTaskFlowAndScenario para obtener el ID del flujo de tareas.
TriggerType	Integer	No	1	El modo en que se activa el flujo de tareas. Valores válidos: 0: El flujo de tareas se activa automáticamente según una programación periódica. 1: El flujo de tareas se activa manualmente.
StartTimeBegin	String	No	2022-01-07	El inicio del intervalo de tiempo para consultar los registros de ejecución del flujo de tareas. Especifique la fecha en formato yyyy-MM-DD.
StartTimeEnd	String	No	2022-04-08	El final del intervalo de tiempo para consultar los registros de ejecución del flujo de tareas. Especifique la fecha en formato yyyy-MM-DD.
PageIndex	Integer	Sí	1	El número de página a devolver.
PageSize	Integer	Sí	20	El número de entradas a devolver por página.
Tid	Long	No	3***	El ID del inquilino. Puede llamar a la operación GetUserActiveTenant o ListUserTenants para obtener el ID del inquilino.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	8CFF2295-8249-5287-B888-DBD4F0D76CB0	El ID de la solicitud.
ErrorCode	String	UnknownError	El código de error devuelto si la solicitud se completó con errores.
ErrorMessage	String	UnknownError	El mensaje de error devuelto si la solicitud se completó con errores.
Success	Boolean	true	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud se completó con errores.
DAGInstanceList	Array of DAGInstance		La información sobre los registros de ejecución devueltos.
DAGInstance
Id	Long	9234	El ID del registro de ejecución.
BusinessTime	String	2021-11-10 14:37:26	La hora en que se inició la ejecución del flujo de tareas. Se muestra en formato yyyy-MM-DD HH:mm:ss.
EndTime	String	2021-11-11 14:38:57	La hora en que finalizó la ejecución del flujo de tareas. Se muestra en formato yyyy-MM-DD HH:mm:ss.
DagId	String	7***	El ID del flujo de tareas.
TriggerType	Integer	1	El modo en que se activa el flujo de tareas. Valores válidos: 0: El flujo de tareas se activa automáticamente según una programación periódica. 1: El flujo de tareas se activa manualmente.
Status	Integer	4	El estado del flujo de tareas. Valores válidos: 0: El flujo de tareas está en espera de programación. 1: El flujo de tareas se está ejecutando. 2: El flujo de tareas está en pausa. 3: El flujo de tareas se completó con errores. 4: El flujo de tareas se ejecutó. 5: El flujo de tareas finalizó.
Message	String	test	La descripción de la tarea.
HistoryDagId	Long	2****	El ID de la versión publicada anteriormente del flujo de tareas.
DagName	String	Spark_SQL_test	El nombre del flujo de tareas.
OwnerName	String	test_name	El nombre del propietario del flujo de tareas.
DagVersion	String	[]	La versión del flujo de tareas.
TotalCount	Integer	1	El número total de registros de ejecución devueltos.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

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>

Formato JSON

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
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.