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

Consulta la información de una tarea.

Descripción de la operación

Debe adquirir DataWorks Basic Edition o una edición superior para usar 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:*

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Id	integer	Sí	El ID de la tarea.	1234
ProjectEnv	string	No	El entorno del espacio de trabajo. Valores válidos: Prod: entorno de producción Dev: entorno de desarrollo	Prod

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	22C97E95-F023-56B5-8852-B1A77A17XXXX
Task	object	Los detalles de la tarea.
Name	string	El nombre de la tarea.	SQL node
Description	string	La descripción de la tarea.	test
WorkflowId	integer	El ID del flujo de trabajo.	1234
InstanceMode	string	El modo de generación de instancias. Valores válidos: T+1: se genera al día siguiente. Immediately: se genera inmediatamente.	T+1
Type	string	El tipo de la tarea.	ODPS_SQL
BaselineId	integer	El ID de la línea base.	1234
Priority	integer	La prioridad de la tarea. Valores válidos: de 1 a 8. Un valor mayor indica una prioridad más alta. Valor predeterminado: 1.	1
Timeout	integer	El tiempo de espera para la ejecución de la tarea. Unidad: segundos.	3600
RerunMode	string	El modo de reejecución. Valores válidos: AllDenied: la tarea no se puede reejecutar, independientemente de si la ejecución finaliza correctamente o falla. FailureAllowed: la tarea se puede reejecutar solo después de que la ejecución falle. AllAllowed: la tarea se puede reejecutar, independientemente de si la ejecución finaliza correctamente o falla.	AllAllowed
RerunTimes	integer	El número de veces que se reejecuta la tarea. Este parámetro surte efecto solo si el parámetro RerunMode se establece en AllAllowed o FailureAllowed.	3
RerunInterval	integer	El intervalo de reejecución. Unidad: segundos.	60
Script	object	La información del script.
Content	string	El contenido del script.	echo "helloWorld"
Parameters	string	Los parámetros del script.	para1=$bizdate
Trigger	object	El método para activar la programación de la tarea.
Type	string	El tipo de activador. Valores válidos: Scheduler: programación periódica Manual: programación manual	Scheduler
Recurrence	string	El modo de ejecución de la tarea después de activarse. Este parámetro surte efecto solo si el parámetro Type se establece en Scheduler. Valores válidos: Pause: en pausa Skip: ejecución de prueba Normal: operación normal	Normal
Cron	string	La expresión CRON de la tarea. Este parámetro surte efecto solo si el parámetro Type se establece en Scheduler.	00 00 00 * * ?
StartTime	string	La hora de inicio del intervalo de tiempo durante el cual se programa periódicamente la tarea. Este parámetro surte efecto solo si el parámetro Type se establece en Scheduler.	1970-01-01 00:00:00
EndTime	string	La hora de finalización del intervalo de tiempo durante el cual se programa periódicamente la tarea. Este parámetro surte efecto solo si el parámetro Type se establece en Scheduler.	9999-01-01 00:00:00
RuntimeResource	object	La configuración del entorno de ejecución, como la información del grupo de recursos.
ResourceGroupId	string	El ID 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) configuradas para la ejecución de la tarea.	0.25
DataSource	object	La información de la fuente de datos asociada.
Name	string	El nombre de la fuente de datos.	mysql_test
Inputs	object	La información de entrada.
Variables	array<object>	Las variables.
	object
Name	string	El nombre de la variable.	key1
Type	string	El tipo. Valores válidos: Constant: constante PassThrough: salida del nodo de parámetros System: variable NodeOutput: salida del script	Constant
Value	string	El valor de la variable.	Value1
Outputs	object	La información de salida.
TaskOutputs	array<object>	Las salidas de la tarea.
	object
Output	string	El identificador de la salida.	pre.odps_sql_demo_0
Variables	array<object>	Las variables.
	object
Name	string	El nombre de la variable.	key1
Type	string	El tipo. Valores válidos: Constant: constante PassThrough: salida del nodo de parámetros System: variable NodeOutput: salida del script	Constant
Value	string	El valor de la variable.	value1
Dependencies	array<object>	La información de dependencias.
	object
Type	string	El tipo de dependencia. Valores válidos: CrossCycleDependsOnChildren: dependencia entre ciclos de nodos descendientes de nivel 1 CrossCycleDependsOnSelf: dependencia entre ciclos del nodo actual CrossCycleDependsOnOtherNode: dependencia entre ciclos de otros nodos Normal: dependencia de programación del mismo ciclo	Normal
UpstreamOutput	string	El identificador de la salida de la tarea ascendente. Este parámetro se devuelve solo si se configuran las `dependencias de programación del mismo ciclo` y la entrada del nodo.	pre.odps_sql_demo_0
UpstreamTaskId	string	El ID de la tarea ascendente. Este campo se devuelve para las dependencias entre ciclos de otros nodos o para las dependencias del mismo ciclo cuando no se configura el contenido de entrada. No se devuelve en otros casos.	1234
SubTasks	object	Las configuraciones de las subtareas, como un nodo do-while.
SubTasks	array<object>	Las subtareas.
	array<object>
Name	string	El nombre de la tarea.	SQL node
Description	string	La descripción de la tarea.	test
WorkflowId	integer	El ID del flujo de trabajo al que pertenece la tarea.	1234
Type	string	El tipo de la tarea.	ODPS_SQL
BaselineId	integer	El ID de la línea base.	The baseline ID.
Priority	integer	La prioridad de la tarea. Valores válidos: de 1 a 8. Un valor mayor indica una prioridad más alta. Valor predeterminado: 1.	1
Timeout	integer	El tiempo de espera para la ejecución de la tarea. Unidad: segundos.	3600
RerunMode	string	El modo de reejecución. Valores válidos: AllDenied: la tarea no se puede reejecutar, independientemente de si la ejecución finaliza correctamente o falla. FailureAllowed: la tarea se puede reejecutar solo después de que la ejecución falle. AllAllowed: la tarea se puede reejecutar, independientemente de si la ejecución finaliza correctamente o falla.	AllAllowed
RerunTimes	integer	El número de veces que se reejecuta la tarea. Este parámetro surte efecto solo si el parámetro RerunMode se establece en AllAllowed o FailureAllowed.	3
RerunInterval	integer	El intervalo de reejecución. Unidad: segundos.	180
Trigger	object	El método para activar la programación de la tarea.
Type	string	El tipo de activador. Valores válidos: Scheduler: programación periódica Manual: programación manual	Scheduler
Recurrence	string	El modo de ejecución de la tarea después de activarse. Este parámetro surte efecto solo si el parámetro Type se establece en Scheduler. Valores válidos: Pause: en pausa Skip: ejecución de prueba Normal: operación normal	Normal
Cron	string	La expresión CRON de la tarea. Este parámetro surte efecto solo si el parámetro Type se establece en Scheduler.	00 00 00 * * ?
StartTime	string	La hora de inicio del intervalo de tiempo durante el cual se programa periódicamente la tarea. Este parámetro surte efecto solo si el parámetro Type se establece en Scheduler.	1970-01-01 00:00:00
EndTime	string	La hora de finalización del intervalo de tiempo durante el cual se programa periódicamente la tarea. Este parámetro surte efecto solo si el parámetro Type se establece en Scheduler.	9999-01-01 00:00:00
RuntimeResource	object	La configuración del entorno de ejecución de la tarea, como el grupo de recursos.
ResourceGroupId	string	El ID 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 CU configuradas para la ejecución de la tarea.	0.25
DataSource	object	La información de la fuente de datos asociada.
Name	string	El nombre de la fuente de datos.	mysql_test
Id	integer	El ID de la tarea.	1234
ProjectId	integer	El ID del espacio de trabajo.	100
ProjectEnv `deprecated`	string	El entorno del espacio de trabajo. Este parámetro está obsoleto y se reemplaza por el parámetro EnvType. Valores válidos: Prod: entorno de producción Dev: entorno de desarrollo	Prod
EnvType	string	El entorno del espacio de trabajo. Valores válidos: Prod: entorno de producción Dev: entorno de desarrollo	Prod
Owner	string	El ID de la cuenta del propietario de la tarea.	1000
CreateTime	integer	La hora de creación.	1710239005403
ModifyTime	integer	La hora de modificación.	1710239005403
CreateUser	string	El ID de la cuenta del creador.	1000
ModifyUser	string	El ID de la cuenta del usuario que modificó la tarea.	1000
Type	string	El tipo de subtarea. Valores válidos: DoWhile: nodo do-while Combined: grupo de nodos ForEach: nodo for-each	Combined
Tags	array<object>	Las etiquetas.
	object
Key	string	La clave de la etiqueta.	key1
Value	string	El valor de la etiqueta.	value1
Id	integer	El identificador único de la tarea.	1234
ProjectId	integer	El ID del espacio de trabajo.	100
ProjectEnv `deprecated`	string	El entorno del espacio de trabajo. Este parámetro está obsoleto y se reemplaza por el parámetro EnvType. Valores válidos: Prod: entorno de producción Dev: entorno de desarrollo	Prod
EnvType	string	El entorno del espacio de trabajo. Valores válidos: Prod: entorno de producción Dev: entorno de desarrollo	Prod
Owner	string	El ID de la cuenta del propietario de la tarea.	1000
CreateTime	integer	La hora de creación.	1710239005403
ModifyTime	integer	La hora de modificación.	1710239005403
CreateUser	string	El ID de la cuenta del creador.	1000
ModifyUser	string	El ID de la cuenta del usuario que modificó la tarea.	1000

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Task": {
    "Name": "SQL node",
    "Description": "test",
    "WorkflowId": 1234,
    "InstanceMode": "T+1",
    "Type": "ODPS_SQL",
    "BaselineId": 1234,
    "Priority": 1,
    "Timeout": 3600,
    "RerunMode": "AllAllowed",
    "RerunTimes": 3,
    "RerunInterval": 60,
    "Script": {
      "Content": "echo \"helloWorld\"",
      "Parameters": "para1=$bizdate"
    },
    "Trigger": {
      "Type": "Scheduler",
      "Recurrence": "Normal",
      "Cron": "00 00 00 * * ?",
      "StartTime": "1970-01-01 00:00:00",
      "EndTime": "9999-01-01 00:00:00"
    },
    "RuntimeResource": {
      "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
      "Image": "i-xxxxxx",
      "Cu": "0.25"
    },
    "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"
        }
      ]
    },
    "Dependencies": [
      {
        "Type": "Normal",
        "UpstreamOutput": "pre.odps_sql_demo_0",
        "UpstreamTaskId": "1234"
      }
    ],
    "SubTasks": {
      "SubTasks": [
        {
          "Name": "SQL node",
          "Description": "test",
          "WorkflowId": 1234,
          "Type": "ODPS_SQL",
          "BaselineId": 0,
          "Priority": 1,
          "Timeout": 3600,
          "RerunMode": "AllAllowed",
          "RerunTimes": 3,
          "RerunInterval": 180,
          "Trigger": {
            "Type": "Scheduler",
            "Recurrence": "Normal",
            "Cron": "00 00 00 * * ?\n",
            "StartTime": "1970-01-01 00:00:00\n",
            "EndTime": "9999-01-01 00:00:00\n"
          },
          "RuntimeResource": {
            "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
            "Image": "i-xxxxxx",
            "Cu": "0.25"
          },
          "DataSource": {
            "Name": "mysql_test"
          },
          "Id": 1234,
          "ProjectId": 100,
          "ProjectEnv": "Prod",
          "EnvType": "Prod",
          "Owner": "1000\n",
          "CreateTime": 1710239005403,
          "ModifyTime": 1710239005403,
          "CreateUser": "1000\n",
          "ModifyUser": "1000\n"
        }
      ],
      "Type": "Combined"
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "Id": 1234,
    "ProjectId": 100,
    "ProjectEnv": "Prod",
    "EnvType": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000\n",
    "ModifyUser": "1000"
  }
}

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.