ListTaskFlowInstance - Data Management - Centro de documentación de Alibaba Cloud

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

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dms:ListTaskFlowInstance

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DagId	integer	Sí	El ID del flujo de tareas. Puede llamar a la operación ListTaskFlow o ListLhTaskFlowAndScenario para obtener el ID del flujo de tareas.	7***
TriggerType	integer	No	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.	1
StartTimeBegin	string	No	El inicio del intervalo de tiempo para consultar los registros de ejecución del flujo de tareas. Especifique la hora en formato yyyy-MM-DD.	2022-01-07
StartTimeEnd	string	No	El fin del intervalo de tiempo para consultar los registros de ejecución del flujo de tareas. Especifique la hora en formato yyyy-MM-DD.	2022-04-08
PageIndex	integer	Sí	El número de la página que se va a devolver.	1
PageSize	integer	Sí	El número de entradas que se van a devolver en cada página.	20
Tid	integer	No	El ID del inquilino. Puede llamar a la operación GetUserActiveTenant o ListUserTenants para obtener el ID del inquilino.	3***
UseBizDate	boolean	No	Ajustar las condiciones de filtro: true: StartTimeBegin y StartTimeEnd son el intervalo de tiempo para filtrar servicios. false: StartTimeBegin y StartTimeEnd son el intervalo de tiempo para la ejecución de la tarea.	true
Status	integer	No	El estado de ejecución del nodo de tarea. Valores válidos: 0: En espera de programación 1: En ejecución 2: Suspendido 3: Error de ejecución 4: Ejecutado correctamente 5: Completado	2

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	8CFF2295-8249-5287-B888-DBD4F0D76CB0
ErrorCode	string	El código de error devuelto si la solicitud falla.	UnknownError
ErrorMessage	string	El mensaje de error devuelto si la solicitud falla.	UnknownError
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
DAGInstanceList	object
DAGInstance	array<object>	La información sobre los registros de ejecución devueltos.
	object
Id	integer	El ID del registro de ejecución.	9234
BusinessTime	string	La hora de negocio del flujo de tareas. La hora se muestra en formato yyyy-MM-DD HH:mm:ss.	2021-11-10 14:37:26
startTime	string	La hora en que se inició la ejecución del flujo de tareas. La hora se muestra en formato yyyy-MM-DD HH:mm:ss.	2021-11-11 14:35:57
EndTime	string	La hora en que se completó la ejecución del flujo de tareas. La hora se muestra en formato yyyy-MM-DD HH:mm:ss.	2021-11-11 14:38:57
DagId	string	El ID del flujo de tareas.	7***
TriggerType	integer	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.	1
Status	integer	El estado del flujo de tareas. Valores válidos: 0: El flujo de tareas está en espera de ser programado. 1: El flujo de tareas se está ejecutando. 2: El flujo de tareas está en pausa. 3: El flujo de tareas falló. 4: El flujo de tareas se ejecutó. 5: El flujo de tareas está completo.	4
Message	string	La descripción de la tarea.	test
HistoryDagId	integer	El ID de la versión publicada anteriormente del flujo de tareas.	2****
DagName	string	El nombre del flujo de tareas.	Spark_SQL_test
OwnerName	string	El nombre del propietario del flujo de tareas.	test_name
DagVersion	string	La versión del flujo de tareas.	[]
TotalCount	integer	El número total de registros de ejecución devueltos.	1

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.