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

Obtiene los detalles de una instancia de tarea especificada.

Descripción de la operación

Debe adquirir DataWorks Basic Edition o una edición posterior para utilizar esta funció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:*

get

*All resources.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Id	integer	Sí	El identificador único de la instancia de tarea.	1234

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La estructura de la respuesta.
RequestId	string	El ID de la solicitud. Puede usar el ID para localizar registros y solucionar problemas.	22C97E95-F023-56B5-8852-B1A77****
TaskInstance	object	Los detalles de la instancia de tarea.
TaskId	integer	El ID de la tarea.	1234
TaskType	string	El tipo de 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 al que pertenece la instancia de tarea.	1234
WorkflowName	string	El nombre del flujo de trabajo al que pertenece la instancia de tarea.	Test workflow
TriggerType	string	El tipo de activador. Puede obtener el tipo de activador del parámetro de respuesta Trigger.Type de la operación GetTask. Valores válidos: Scheduler: La tarea se activa mediante un ciclo de programación. Manual: La tarea se activa manualmente.	Scheduler
TriggerRecurrence	string	El modo de ejecución al activarse. Este parámetro solo surte efecto cuando TriggerType se establece en Scheduler. Valores válidos: Normal: La tarea es una tarea programada normal y se programa diariamente. Manual: La tarea es una tarea manual y no se programa diariamente. Pause: La tarea está pausada. Se programa diariamente, pero se establece directamente como fallida cuando se activa la programación. Skip: La tarea realiza una ejecución de prueba. Se programa diariamente, pero se establece directamente como exitosa cuando se activa la programación. SkipUnchoose: La tarea es una tarea no seleccionada en un flujo de trabajo temporal. Solo existe en flujos de trabajo temporales y se establece directamente como exitosa cuando se activa la programación. SkipCycle: La tarea es una tarea semanal o mensual que no ha alcanzado su ciclo de ejecución. Se programa diariamente, pero se establece directamente como exitosa cuando se activa la programación. ConditionUnchoose: El nodo descendente no es seleccionado por un nodo de ramificación (IF) ascendente. La tarea se establece directamente como ejecución de prueba. RealtimeDeprecated: La tarea es una instancia periódica caducada generada en tiempo real. Se establece directamente como exitosa. PauseCalendar: La instancia se pausa debido a un calendario referenciado. SkipCalendar: La instancia realiza una ejecución de prueba debido a un calendario referenciado.	Normal
WorkflowInstanceId	integer	El ID de la instancia de flujo de trabajo a la que pertenece la instancia de tarea.	1234
WorkflowInstanceType	string	El tipo de la instancia de flujo de trabajo a la que pertenece la instancia de tarea. Valores válidos: SmokeTest: La instancia es una prueba de humo. SupplementData: La instancia es para relleno de datos. Manual: La instancia es una tarea manual. ManualWorkflow: La instancia es un flujo de trabajo manual. Normal: La instancia utiliza programación periódica. ManualFlow: La instancia es un flujo de negocio ejecutado manualmente.	Normal
UnifiedWorkflowInstanceId	integer	El ID de instancia de flujo de trabajo unificado. El valor de este campo es el mismo para todas las instancias de tarea dentro de una fecha de negocio específica bajo un único activador.	1234
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 la hora más cercana.	3600
RerunMode	string	La configuración que especifica si la tarea se puede reejecutar. Valores válidos: AllDenied: La tarea no se puede reejecutar independientemente de si falla o tiene éxito. AllAllowed: La tarea se puede reejecutar independientemente de si falla o tiene éxito. FailureAllowed: La tarea solo se puede reejecutar si falla.	AllAllowed
RunNumber	integer	El número actual de ejecuciones. Valor predeterminado: 1.	1
PeriodNumber	integer	El número de periodo. Indica la secuencia del ciclo de ejecución para 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: 1 a 8. Un valor mayor indica una prioridad más alta. Valor predeterminado: 1.	1
Script	object	La información sobre el script de ejecución.
Content	string	El contenido del script.	echo "helloWorld"
Parameters	string	La lista de parámetros del script.	para1=$bizdate
RuntimeResource	object	La información sobre el grupo de recursos asociado con 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 consumo de unidades de computación (CU) configurado para 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 del proceso de ejecución.	T3_123
Gateway	string	La máquina en la que se ejecuta la tarea.	cn-shanghai.1.2
DataSource	object	La información sobre el origen de datos asociado con la instancia.
Name	string	El nombre del origen de datos.	mysql_test
Inputs	object	La información de entrada.
Variables	array<object>	La lista de definiciones de variables.
	object	La lista de definiciones de variables.
Name	string	El nombre de la variable.	Key1
Type	string	El tipo de la variable. Valores válidos: Constant: La variable es una constante. PassThrough: La variable es la salida de un nodo de parámetro. System: La variable es una variable del sistema. NodeOutput: La variable es la salida del script.	Constant
Value	string	El valor de la variable.	Value1
Outputs	object	La información de salida.
TaskOutputs	array<object>	La lista de definiciones de salida de la tarea.
	object	La lista de definiciones de salida de la tarea.
Output	string	El identificador de salida.	pre.odps_sql_demo_0
Variables	array<object>	La lista de definiciones de variables.
	object	La lista de definiciones de variables.
Name	string	El nombre de la variable.	key1
Type	string	El tipo de la variable. Valores válidos: Constant: La variable es una constante. PassThrough: La variable es la salida de un nodo de parámetro. System: La variable es una variable del sistema. NodeOutput: La variable es la salida del script.	Constant
Value	string	El valor de la variable.	value1
Tags	array<object>	La lista de etiquetas de tarea.
	object	La lista de etiquetas de tarea.
Key	string	La clave de la etiqueta.	key1
Value	string	El valor de la etiqueta.	value1
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: Comprobación de las condiciones de ramificación. WaitResource: En espera de recursos. Failure: Error de ejecución. Success: Ejecución correcta. Checking: Enviado para la comprobación de la calidad de los datos. WaitTrigger: En espera de una activación externa. Los nodos activados 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 UNIX de 13 dígitos en milisegundos.	1710239005403
Bizdate	integer	La fecha de negocio. El valor es una marca de tiempo UNIX de 13 dígitos en milisegundos.	1710239005403
StartedTime	integer	La hora de inicio. El valor es una marca de tiempo UNIX de 13 dígitos en milisegundos.	1710239005403
FinishedTime	integer	La hora de finalización. El valor es una marca de tiempo UNIX de 13 dígitos en milisegundos.	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 la cuenta del propietario de la tarea.	1000
CreateTime	integer	La hora de creación. El valor es una marca de tiempo UNIX de 13 dígitos en milisegundos.	1710239005403
ModifyTime	integer	La hora de actualización. El valor es una marca de tiempo UNIX de 13 dígitos en milisegundos.	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 actualizó la instancia.	1000
WaitingResourceTime	integer	La hora en la que la instancia comienza a esperar recursos.	1710239005403
WaitingTriggerTime	integer	La hora en la que la instancia comienza a esperar la activación programada. El valor es una marca de tiempo UNIX de 13 dígitos en milisegundos.	1710239005403
OperationType	string	El tipo de la operación más reciente en la instancia.	TriggerDqc

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77****",
  "TaskInstance": {
    "TaskId": 1234,
    "TaskType": "ODPS_SQL",
    "TaskName": "SQL node\n",
    "Description": "test",
    "WorkflowId": 1234,
    "WorkflowName": "Test workflow",
    "TriggerType": "Scheduler",
    "TriggerRecurrence": "Normal",
    "WorkflowInstanceId": 1234,
    "WorkflowInstanceType": "Normal",
    "UnifiedWorkflowInstanceId": 1234,
    "Timeout": 3600,
    "RerunMode": "AllAllowed",
    "RunNumber": 1,
    "PeriodNumber": 1,
    "BaselineId": 1234,
    "Priority": 1,
    "Script": {
      "Content": "echo \"helloWorld\"",
      "Parameters": "para1=$bizdate"
    },
    "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"
    },
    "Inputs": {
      "Variables": [
        {
          "Name": "Key1",
          "Type": "Constant",
          "Value": "Value1"
        }
      ]
    },
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ],
      "Variables": [
        {
          "Name": "key1",
          "Type": "Constant",
          "Value": "value1"
        }
      ]
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "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",
    "WaitingResourceTime": 1710239005403,
    "WaitingTriggerTime": 1710239005403,
    "OperationType": "TriggerDqc"
  }
}

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.