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

Obtiene de forma paginada las instancias ascendentes de una instancia especificada.

Descripción de la operación

Se requiere DataWorks Basic Edition o una edición más avanzada.

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:*

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Id	integer	Sí	El ID de la instancia.	1234
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10.	10
PageNumber	integer	No	El número de página. Las páginas comienzan en 1. Valor predeterminado: 1.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud, que se utiliza para localizar registros y solucionar problemas.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	La información de paginación.
TaskInstances	array<object>	[Obsoleto] La lista de instancias de tareas. Este campo está obsoleto. Utilice UpstreamTaskInstances en su lugar.
	array<object>
StepType	string	El tipo de dependencia. Valores válidos: Normal: dependencia del mismo ciclo. CrossCycle: dependencia entre ciclos.	Normal
TaskId	integer	El ID de la tarea correspondiente.	1234
TaskType	string	El tipo de la tarea correspondiente.	ODPS_SQL
TaskName	string	El nombre de la tarea correspondiente.	SQL node
Description	string	La descripción.	test
WorkflowId	integer	El ID del flujo de trabajo al que pertenece la instancia.	1234
WorkflowName	string	El nombre del flujo de trabajo al que pertenece la instancia.	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 la instancia. Este parámetro surte efecto cuando TriggerType se establece en Scheduler. Valores válidos: Pause: en pausa. Skip: ejecución de prueba. Normal: ejecución normal.	Normal
WorkflowInstanceId	integer	El ID de la instancia de flujo de trabajo a la que pertenece la instancia.	1234
WorkflowInstanceType	string	El tipo de la instancia de flujo de trabajo a la que pertenece la instancia. Valores válidos: SmokeTest: prueba. SupplementData: backfill de datos. Manual: manual. ManualWorkflow: flujo de trabajo manual. Normal: ejecución programada. ManualFlow: flujo de trabajo 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 del nodo. Valores válidos: AllDenied: El nodo no se puede reejecutar independientemente de si falla o tiene éxito. FailureAllowed: El nodo solo se puede reejecutar después de que falle. AllAllowed: El nodo se puede reejecutar independientemente de si falla o tiene éxito.	AllAllowed
RunNumber	integer	El número de ejecución actual, que comienza en 1 de forma predeterminada.	1
PeriodNumber	integer	El número de periodo. Indica a qué ciclo de programación del día pertenece la instancia de la tarea.	1
BaselineId	integer	El ID de la línea base.	1234
Priority	integer	La prioridad de ejecución de la tarea. Valor mínimo: 1. Valor máximo: 8. Un valor mayor indica una prioridad más alta. Valor predeterminado: 1.	1
RuntimeResource	object	La configuración del entorno de ejecución, como la información del grupo de recursos.
ResourceGroupId	string	El identificador del grupo de recursos de programación configurado para la tarea.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	El ID de la imagen configurada para la tarea.	i-xxxxxx
Cu	string	El consumo de unidades de cómputo (CU) configurado para la tarea.	0.25
Runtime	object	La información de ejecución de la instancia.
ProcessId	string	El ID de ejecución único.	T3_123
Gateway	string	La máquina en la que se ejecuta la tarea.	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 ejecutada. Running: en ejecución. WaitTime: en espera de TriggerTime. CheckingCondition: en comprobación de condiciones de ramificación. WaitResource: en espera de recursos. Failure: ejecución fallida. Success: ejecución exitosa. Checking: enviada para comprobación de calidad de datos.	Success
TriggerTime	integer	La hora de activación programada. El valor es un número de 13 dígitos, por ejemplo, 1710239005403.	1710239005403
Bizdate	integer	La fecha de negocio. El valor es un número de 13 dígitos, por ejemplo, 1710239005403.	1710239005403
StartedTime	integer	La hora en que la instancia comenzó a ejecutarse. El valor es un número de 13 dígitos, por ejemplo, 1710239005403.	1710239005403
FinishedTime	integer	La hora en que la instancia terminó de ejecutarse. El valor es un número de 13 dígitos, por ejemplo, 1710239005403.	1710239005403
Id	integer	El identificador único de la instancia de la tarea.	1234
ProjectId	integer	El ID del proyecto.	100
ProjectEnv `deprecated`	string	El entorno del proyecto. Prod: producción. Dev: desarrollo.	Prod
EnvType	string	El entorno del proyecto. Prod: producción. Dev: desarrollo.	Prod
Owner	string	El ID de la cuenta del propietario de la tarea.	1000
CreateTime	integer	La hora de creación. El valor es un número de 13 dígitos, por ejemplo, 1710239005403.	1710239005403
ModifyTime	integer	La hora de modificación. El valor es un número de 13 dígitos, por ejemplo, 1710239005403.	1710239005403
CreateUser	string	El ID de la cuenta del usuario que creó la instancia.	1000
ModifyUser	string	El ID de la cuenta del usuario que modificó la instancia por última vez.	1000
UpstreamTaskInstances	array<object>	La lista de instancias de tareas upstream.
	array<object>
DependencyType	string	El tipo de dependencia. Valores válidos: Normal: dependencia del mismo ciclo. CrossCycle: dependencia entre ciclos.	Normal
TaskInstance	object	Los detalles de la instancia de la tarea.
TaskId	integer	El ID de la tarea correspondiente.	1234
TaskType	string	El tipo de la tarea correspondiente.	ODPS_SQL
TaskName	string	El nombre de la tarea correspondiente.	SQL node
Description	string	La descripción.	test
WorkflowId	integer	El ID del flujo de trabajo al que pertenece la instancia.	1234
WorkflowName	string	El nombre del flujo de trabajo al que pertenece la instancia.	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 la instancia. Este parámetro surte efecto cuando TriggerType se establece en Scheduler. Valores válidos: Pause: en pausa. Skip: ejecución de prueba. Normal: ejecución normal.	Normal
WorkflowInstanceId	integer	El ID de la instancia de flujo de trabajo a la que pertenece la instancia.	1234
WorkflowInstanceType	string	El tipo de la instancia de flujo de trabajo a la que pertenece la instancia. Valores válidos: Normal: ejecución programada. Manual: tarea manual. SmokeTest: prueba. SupplementData: backfill de datos. ManualWorkflow: flujo de trabajo manual.	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 que especifica si la tarea se puede reejecutar.	AllAllowed
RunNumber	integer	El número de ejecución actual, que comienza en 1 de forma predeterminada.	1
PeriodNumber	integer	El número de periodo. Indica a qué ciclo de programación del día pertenece la instancia de la tarea.	1
BaselineId	integer	El ID de la línea base.	1234
Priority	integer	La prioridad de ejecución de la tarea. Valor mínimo: 1. Valor máximo: 8. Un valor mayor indica una prioridad más alta. Valor predeterminado: 1.	1
RuntimeResource	object	La configuración del entorno de ejecución, como la información del grupo de recursos.
ResourceGroupId	string	El identificador del grupo de recursos de programación configurado para la tarea.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	El ID de la imagen configurada para la tarea.	i-xxxxxx
Cu	string	El consumo de unidades de cómputo (CU) configurado para la tarea.	0.25
Runtime	object	La información de ejecución de la instancia.
ProcessId	string	El ID de ejecución único.	T3_123
Gateway	string	La máquina en la que se ejecuta la tarea.	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 se ha ejecutado. Running: en ejecución. WaitTime: a la espera de TriggerTime. CheckingCondition: se comprueban las condiciones de la rama. WaitResource: a la espera de recursos. Failure: la ejecución falló. Success: la ejecución se completó correctamente. Checking: se ha enviado para la comprobación de calidad de datos. WaitTrigger: a la espera de un disparador externo. Los nodos basados en disparadores pasan a este estado después del periodo de espera.	Success
TriggerTime	integer	La hora de activación programada. El valor es un número de 13 dígitos, por ejemplo, 1710239005403.	1710239005403
Bizdate	integer	La fecha de negocio. El valor es un número de 13 dígitos, por ejemplo, 1710239005403.	1710239005403
StartedTime	integer	La hora en que la instancia comenzó a ejecutarse. El valor es un número de 13 dígitos, por ejemplo, 1710239005403.	1710239005403
FinishedTime	integer	La hora en que la instancia terminó de ejecutarse. El valor es un número de 13 dígitos, por ejemplo, 1710239005403.	1710239005403
Id	integer	El identificador único de la instancia de la tarea.	1234
ProjectId	integer	El ID del proyecto.	100
EnvType	string	El entorno del origen de datos de destino. Valores válidos: Dev: entorno de desarrollo. Prod: entorno de producción.	Prod
Owner	string	El ID de la cuenta del propietario de la tarea.	1000
CreateTime	integer	La hora de creación. El valor es un número de 13 dígitos, por ejemplo, 1710239005403.	1710239005403
ModifyTime	integer	La hora de modificación. El valor es un número de 13 dígitos, por ejemplo, 1710239005403.	1710239005403
CreateUser	string	El ID de la cuenta del usuario que creó la instancia.	1000
ModifyUser	string	El ID de la cuenta del usuario que modificó la instancia por última vez.	1000
TotalCount	integer	El número total de registros.	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": [
      {
        "StepType": "Normal",
        "TaskId": 1234,
        "TaskType": "ODPS_SQL",
        "TaskName": "Nodo SQL",
        "Description": "prueba",
        "WorkflowId": 1234,
        "WorkflowName": "Flujo de trabajo de prueba",
        "TriggerType": "Scheduler",
        "TriggerRecurrence": "Normal",
        "WorkflowInstanceId": 1234,
        "WorkflowInstanceType": "Normal",
        "Timeout": 3600,
        "RerunMode": "AllAllowed",
        "RunNumber": 1,
        "PeriodNumber": 1,
        "BaselineId": 1234,
        "Priority": 1,
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx",
          "Cu": "0.25"
        },
        "Runtime": {
          "ProcessId": "T3_123",
          "Gateway": "cn-shanghai.1.2"
        },
        "DataSource": {
          "Name": "mysql_test"
        },
        "Status": "Success",
        "TriggerTime": 1710239005403,
        "Bizdate": 1710239005403,
        "StartedTime": 1710239005403,
        "FinishedTime": 1710239005403,
        "Id": 1234,
        "ProjectId": 100,
        "ProjectEnv": "Prod",
        "EnvType": "Prod",
        "Owner": "1000",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000"
      }
    ],
    "UpstreamTaskInstances": [
      {
        "DependencyType": "Normal",
        "TaskInstance": {
          "TaskId": 1234,
          "TaskType": "ODPS_SQL",
          "TaskName": "Nodo SQL",
          "Description": "prueba",
          "WorkflowId": 1234,
          "WorkflowName": "Flujo de trabajo de prueba",
          "TriggerType": "Scheduler",
          "TriggerRecurrence": "Normal",
          "WorkflowInstanceId": 1234,
          "WorkflowInstanceType": "Normal",
          "Timeout": 3600,
          "RerunMode": "AllAllowed",
          "RunNumber": 1,
          "PeriodNumber": 1,
          "BaselineId": 1234,
          "Priority": 1,
          "RuntimeResource": {
            "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
            "Image": "i-xxxxxx",
            "Cu": "0.25"
          },
          "Runtime": {
            "ProcessId": "T3_123",
            "Gateway": "cn-shanghai.1.2"
          },
          "DataSource": {
            "Name": "mysql_test"
          },
          "Status": "Success",
          "TriggerTime": 1710239005403,
          "Bizdate": 1710239005403,
          "StartedTime": 1710239005403,
          "FinishedTime": 1710239005403,
          "Id": 1234,
          "ProjectId": 100,
          "EnvType": "Prod",
          "Owner": "1000",
          "CreateTime": 1710239005403,
          "ModifyTime": 1710239005403,
          "CreateUser": "1000",
          "ModifyUser": "1000"
        }
      }
    ],
    "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.