ListTaskInstances - DataWorks - Centro de documentación de Alibaba Cloud

Obtiene una lista paginada de instancias de tarea. También puede realizar una consulta filtrada según condiciones.

Descripción de la operación

Debe adquirir DataWorks Basic Edition o una edición posterior para utilizar esta operación.

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

dataworks:ListTaskInstances

get

*TaskInstance

acs:dataworks:{#regionId}:{#accountId}:taskinstance/*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectId	integer	Sí	El ID del proyecto.	100
Bizdate	integer	Sí	La fecha de negocio. Por lo general, es las 00:00:00 del día anterior a la hora programada de la instancia periódica, en formato de marca de tiempo a nivel de milisegundos, como 1743350400000.	1710239005403
TaskId	integer	No	El ID de la tarea.	1234
TaskIds	array	No	Los ID de las tareas. Puede especificar varios ID de tareas para consultar instancias de tarea en lotes.
	integer	No	El ID de la tarea.	1234
TaskName	string	No	El nombre de la tarea. Se admite la coincidencia aproximada.	SQL node
Owner	string	No	El ID de cuenta del propietario de la tarea.	1000
TaskType	string	No	El tipo de tarea. Para consultar los valores válidos de TaskType para cada nodo, consulte Tipos de nodos de DataWorks.	ODPS_SQL
RuntimeResource	string	No	La información del grupo de recursos. Especifique el identificador del grupo de recursos de programación.	S_res_group_524258031846018_1684XXXXXXXXX
WorkflowId	integer	No	El ID del flujo de trabajo asociado.	1234
UnifiedWorkflowInstanceId	integer	No	El ID de instancia de flujo de trabajo unificado. Este valor es el mismo para todas las instancias de tarea dentro de una fecha de negocio específica bajo un único desencadenador.	1234
WorkflowInstanceType	string	No	El tipo de instancia de flujo de trabajo. Valores válidos: SmokeTest: prueba Manual: tarea manual SupplementData: backfill de datos ManualWorkflow: flujo de trabajo manual Normal: programación periódica TriggerWorkflow: flujo de trabajo desencadenado Valores válidos: SmokeTest : Prueba. TriggerWorkflow : Flujo de trabajo desencadenado. Manual : Tarea manual. SupplementData : Backfill de datos. ManualWorkflow : Flujo de trabajo manual. Normal : Programación periódica.	Normal
WorkflowInstanceId	integer	No	El ID de la instancia de flujo de trabajo asociada.	1234
ProjectEnv	string	No	El entorno del proyecto. Valores válidos: Prod: producción Dev: desarrollo Valores válidos: Prod : Producción. Dev : Desarrollo.	Prod
Id	integer	No	El ID de la instancia de tarea. Una instancia de tarea puede volver a ejecutarse. Si especifica este parámetro, la respuesta incluye registros históricos de nuevas ejecuciones, los cuales se distinguen por RunNumber.	1234
Ids	array	No	Los ID de las instancias de tarea. Puede especificar varios ID de instancias de tarea para consultar instancias de tarea en lotes.
	integer	No	El ID de la instancia de tarea.	1234
TriggerType	string	No	El tipo de desencadenador. Valores válidos: Scheduler: programación periódica Manual: manual Valores válidos: Scheduler : Programación periódica. Manual : Manual.	Normal
TriggerRecurrence	string	No	El modo de ejecución al desencadenar. Este parámetro solo surte efecto cuando TriggerType se establece en Scheduler. Valores válidos: Pause: pausa Skip: ejecución de prueba Normal: ejecución normal Valores válidos: Pause : Pausa. Skip : Ejecución de prueba. Normal : Ejecución normal.	Normal
SortBy	string	No	El campo de ordenación. Se admiten campos como la hora programada y la hora de inicio. El formato es 'Campo de ordenación + Orden de clasificación (Desc/Asc)', donde Asc se puede omitir. Valores válidos para el campo de ordenación: `TriggerTime (Desc/Asc)` `StartedTime (Desc/Asc)` `FinishedTime (Desc/Asc)` `CreateTime (Desc/Asc)` `Id (Desc/Asc)` Valor predeterminado: `Id Desc`	Id Desc
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 500.	10
PageNumber	integer	No	El número de página. Las páginas comienzan desde 1. Valor predeterminado: 1.	1
Status	string	No	El estado de la instancia de tarea. Valores válidos: `NotRun`: no ejecutada `Running`: en ejecución `Failure`: fallida `Success`: correcta `WaitTime`: en espera de la hora programada `WaitResource`: en espera de recursos Valores válidos: NotRun : No ejecutada. Running : En ejecución. WaitTime : En espera de la hora programada. WaitResource : En espera de recursos. Failure : Fallida. Success : Correcta.	Success
Filter	string	No	Las condiciones de filtro en formato JSON. Varias condiciones de filtro se combinan con el operador lógico AND. Campos admitidos: `startedTimeStart`, `startedTimeEnd`, `finishedTimeStart`, `finishedTimeEnd`, `createTimeStart` y `createTimeEnd`.	{ "startedTimeStart": "1763481600000", "startedTimeEnd": "1763481600000", "finishedTimeStart": "1763481600000", "finishedTimeEnd": "1763481600000", "createTimeStart": "1763481600000", "createTimeEnd": "1763481600000" }

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	La información de paginación.
TaskInstances	array<object>	La lista de instancias de tarea.
	array<object>
TaskId	integer	El ID de la tarea.	1234
TaskType	string	El tipo de la tarea.	ODPS_SQL
TaskName	string	El nombre de la tarea.	SQL node
Description	string	La descripción.	test
WorkflowId	integer	El ID del flujo de trabajo asociado.	1234
WorkflowName	string	El nombre del flujo de trabajo al que pertenece la instancia de tarea.	Test workflow
TriggerType	string	El tipo de activador. Valores válidos: Scheduler: Activado por un ciclo de programación. Manual: Activado manualmente.	Scheduler
TriggerRecurrence	string	El modo de ejecución cuando se activa el nodo. Este parámetro solo surte efecto cuando TriggerType se establece en Scheduler. Valores válidos: Pause: El nodo está en pausa. Skip: El nodo realiza una ejecución de prueba. Normal: El nodo se ejecuta normalmente.	Normal
WorkflowInstanceId	integer	El ID de la instancia de flujo de trabajo asociada.	1234
UnifiedWorkflowInstanceId	integer	El ID de instancia de flujo de trabajo unificado. Este valor es el mismo para todas las instancias de tarea dentro de una fecha de negocio específica bajo un único desencadenador.	1234
WorkflowInstanceType	string	El tipo de instancia de flujo de trabajo al que pertenece la instancia de tarea. Valores válidos: SmokeTest: Prueba de humo. SupplementData: Relleno de datos. Manual: Ejecución manual. ManualWorkflow: Flujo de trabajo manual. Normal: Ciclo programado. ManualFlow: Flujo de negocio ejecutado manualmente.	Normal
Timeout	integer	El tiempo de espera para la ejecución de la tarea, en segundos. Nota: El sistema de programación redondea el valor configurado a horas completas.	3600
RerunMode	string	La configuración de reejecución para la tarea. Valores válidos: AllDenied: No se permiten reejecuciones independientemente de si hay éxito o fallo. FailureAllowed: Solo se permiten reejecuciones después de un fallo. AllAllowed: Se permiten reejecuciones tanto después de éxitos como de fallos.	AllAllowed
RunNumber	integer	El número de ejecución actual. Valor predeterminado: 1.	1
PeriodNumber	integer	El número de ciclo. Indica la ronda del ciclo de la instancia de tarea en el día actual.	1
BaselineId	integer	El ID de la línea base.	1234
Priority	integer	La prioridad de ejecución de la tarea. Valores válidos: del 1 al 8. Un valor mayor indica una prioridad más alta. Valor predeterminado: 1.	1
RuntimeResource	object	La información del grupo de recursos asociada a la instancia.
ResourceGroupId	string	El identificador del grupo de recursos de programación configurado para la ejecución de la tarea.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	El ID de la imagen configurada para la ejecución de la tarea.	i-xxxxxx
Cu	string	El número de unidades de cómputo (CU) consumidas durante la ejecución de la tarea.	0.25
Runtime	object	La información de tiempo de ejecución de la instancia.
ProcessId	string	El ID único de la ejecución.	T3_123
Gateway	string	La máquina de puerta de enlace.	cn-shanghai.1.2
DataSource	object	La información del origen de datos asociada a la instancia.
Name	string	El nombre del origen de datos.	mysql_test
Status	string	El estado de ejecución de la instancia. Valores válidos: NotRun: No ejecutado. Running: En ejecución. WaitTime: En espera de la hora de activación. CheckingCondition: Comprobando condiciones de ramificación. WaitResource: En espera de recursos. Failure: Fallido. Success: Exitoso. Checking: Enviado para comprobación de calidad de datos. WaitTrigger: En espera de un activador externo. Los nodos basados en activadores cambian a este estado después del tiempo de espera.	Success
TriggerTime	integer	La hora de activación programada. El valor es una marca de tiempo de 13 dígitos, como `1710239005403`.	1710239005403
Bizdate	integer	La fecha de negocio. El valor es una marca de tiempo de 13 dígitos, como `1710239005403`.	1710239005403
StartedTime	integer	La hora de inicio. El valor es una marca de tiempo de 13 dígitos, como `1710239005403`.	1710239005403
FinishedTime	integer	La hora de finalización. El valor es una marca de tiempo de 13 dígitos, como `1710239005403`.	1710239005403
Id	integer	El identificador único de la instancia de tarea.	1234
ProjectId	integer	El ID del proyecto.	100
ProjectEnv	string	El entorno del proyecto. Valores válidos: Prod: producción Dev: desarrollo	Prod
Owner	string	El ID de cuenta del propietario de la tarea.	1000
CreateTime	integer	La hora de creación. El valor es una marca de tiempo de 13 dígitos, como `1710239005403`.	1710239005403
ModifyTime	integer	La hora de actualización. El valor es una marca de tiempo de 13 dígitos, como `1710239005403`.	1710239005403
CreateUser	string	El ID de cuenta del usuario que creó la instancia.	1000
ModifyUser	string	El ID de cuenta del usuario que modificó la instancia por última vez.	1000
ScriptParameters	string	La lista de parámetros del script.	para1=val1 para2=val2
WaitingResourceTime	integer	La hora en que la instancia comienza a esperar recursos.	1710239005403
WaitingTriggerTime	integer	La hora en que la instancia comienza a esperar la hora de activación programada. El valor es una marca de tiempo de 13 dígitos, como `1710239005403`.	1710239005403
OperationType	string	El tipo de la operación más reciente realizada en la instancia.	TriggerDqc
TotalCount	integer	El número total de entradas.	100
PageSize	integer	El número de entradas por página.	10
PageNumber	integer	El número de página.	1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "PagingInfo": {
    "TaskInstances": [
      {
        "TaskId": 1234,
        "TaskType": "ODPS_SQL\n",
        "TaskName": "SQL node\n",
        "Description": "test\n",
        "WorkflowId": 1234,
        "WorkflowName": "Test workflow\n",
        "TriggerType": "Scheduler\n",
        "TriggerRecurrence": "Normal\n",
        "WorkflowInstanceId": 1234,
        "UnifiedWorkflowInstanceId": 1234,
        "WorkflowInstanceType": "Normal",
        "Timeout": 3600,
        "RerunMode": "AllAllowed\n",
        "RunNumber": 1,
        "PeriodNumber": 1,
        "BaselineId": 1234,
        "Priority": 1,
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx\n",
          "Cu": "0.25\n"
        },
        "Runtime": {
          "ProcessId": "T3_123\n",
          "Gateway": "cn-shanghai.1.2\n"
        },
        "DataSource": {
          "Name": "mysql_test\n"
        },
        "Status": "Success",
        "TriggerTime": 1710239005403,
        "Bizdate": 1710239005403,
        "StartedTime": 1710239005403,
        "FinishedTime": 1710239005403,
        "Id": 1234,
        "ProjectId": 100,
        "ProjectEnv": "Prod",
        "Owner": "1000",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000",
        "ScriptParameters": "para1=val1 para2=val2",
        "WaitingResourceTime": 1710239005403,
        "WaitingTriggerTime": 1710239005403,
        "OperationType": "TriggerDqc"
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 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.