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

Actualiza un flujo de trabajo especificado mediante el método de actualización completa. Los campos que se pueden actualizar de forma síncrona en Data Studio incluyen: propietario, origen de datos, grupo de recursos de programación, descripción y modo de ejecución del disparador (Normal, Skip o Pause).

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

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Id	integer	Sí	El ID del flujo de trabajo.	1234
EnvType	string	No	El entorno del proyecto. Valores válidos: Prod: producción Dev: desarrollo	Prod
Name	string	Sí	El nombre.	My Workflow
Owner	string	Sí	El ID de cuenta del propietario.	1000
Trigger	object	Sí	La configuración del disparador.
Type	string	Sí	El tipo de disparador. Valores válidos: Scheduler: se dispara mediante un ciclo de programación Manual: se dispara manualmente	Scheduler
Cron	string	No	La expresión cron. Este parámetro solo surte efecto cuando el tipo se establece en Scheduler.	00 00 00 * * ?
StartTime	string	No	La hora en la que el disparador periódico surte efecto. Este parámetro solo surte efecto cuando el tipo se establece en Scheduler. Formato: `yyyy-mm-dd hh:mm:ss`.	1970-01-01 00:00:00
EndTime	string	No	La hora en la que el disparador periódico expira. Este parámetro solo surte efecto cuando el tipo se establece en Scheduler. Formato: `yyyy-mm-dd hh:mm:ss`.	9999-01-01 00:00:00
Description	string	No	La descripción.	test
Dependencies	array<object>	No	La información de dependencias.
	object	No
Type	string	Sí	El tipo de dependencia. Valores válidos: CrossCycleDependsOnChildren: dependencia entre ciclos en nodos secundarios de primer nivel CrossCycleDependsOnSelf: dependencia entre ciclos en el nodo actual CrossCycleDependsOnOtherNode: dependencia entre ciclos en otros nodos Normal: dependencia en el mismo ciclo	Normal
UpstreamOutput	string	No	El identificador de salida del nodo superior. Este campo se devuelve cuando el tipo de dependencia es `dependencia en el mismo ciclo` y se especifica el contenido de entrada.	pre.odps_sql_demo_0
UpstreamTaskId	integer	No	El ID del nodo superior. Este campo se devuelve cuando el tipo de dependencia es `dependencia entre ciclos en otros nodos` o `dependencia en el mismo ciclo` sin contenido de entrada especificado. No se devuelve en otros casos.	1234
Parameters	string	No	La lista de parámetros.	para1=$bizdate para2=$[yyyymmdd]
Tasks	array<object>	No	La lista de nodos.
	array<object>	No
Id	integer	No	El ID del nodo. Si se especifica este campo, el nodo correspondiente se actualiza por completo. Si no se especifica este campo, se crea un nodo nuevo.	1234
Name	string	Sí	El nombre del nodo.	SQL node
Description	string	No	La descripción.	Test
Type	string	Sí	El tipo de nodo.	ODPS_SQL
Owner	string	Sí	El ID de cuenta del propietario.	1000
BaseLineId	integer	No	El ID de la línea base.	1234
Timeout	integer	No	El tiempo de espera para la ejecución del nodo, en segundos.	3600
RerunMode	string	Sí	Especifica si el nodo se puede volver a ejecutar. Valores válidos: AllDenied: no se puede volver a ejecutar independientemente de si tiene éxito o falla FailureAllowed: solo se puede volver a ejecutar en caso de falla AllAllowed: se puede volver a ejecutar independientemente de si tiene éxito o falla	AllAllowed
RerunTimes	integer	No	El número de reintentos. Este parámetro solo surte efecto cuando el nodo está configurado para permitir nuevas ejecuciones.	3
RerunInterval	integer	No	El intervalo de tiempo de reintento, en segundos.	60
Script	object	No	La información del script.
Content	string	No	El contenido del script.	echo "helloWorld"
Parameters	string	No	La lista de parámetros del script.	para1=$bizdate
Trigger	object	Sí	La configuración del disparador del nodo.
Type	string	No	El tipo de disparador. Valores válidos: Scheduler: se dispara mediante un ciclo de programación Manual: se dispara manualmente	Scheduler
Recurrence	string	Sí	El modo de ejecución al dispararse. Este parámetro solo surte efecto cuando el tipo se establece en Scheduler. Valores válidos: Pause: en pausa Skip: ejecución de prueba Normal: ejecución normal	Normal
RuntimeResource	object	Sí	La configuración del entorno de ejecución, como la información del grupo de recursos.
ResourceGroupId	string	Sí	El identificador del grupo de recursos de programación configurado para el nodo.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	No	El ID de la imagen configurada para el nodo.	i-xxxxxx
Cu	string	No	El consumo de CU configurado para el nodo.	0.25
DataSource	object	No	La información del origen de datos asociado.
Name	string	No	El nombre del origen de datos.	odps_test
Inputs	object	No	La información de entrada. Si este campo está vacío, todas las configuraciones de Inputs se eliminan de forma predeterminada.
Variables	array<object>	No	La lista de definiciones de variables. Si no se especifica este campo o es una matriz vacía, todas las configuraciones de Inputs.Variables se eliminan de forma predeterminada.
	object	No
Name	string	No	El nombre de la variable.	key1
Type	string	Sí	El tipo. Valores válidos: Constant: constante PassThrough: salida de un nodo de parámetro System: variable NodeOutput: salida del script	Constant
Value	string	No	El valor de la variable.	value1
Outputs	object	No	La información de salida. Si este campo está vacío, todas las configuraciones de Outputs se eliminan de forma predeterminada.
TaskOutputs	array<object>	No	La lista de definiciones de salida del nodo. Si no se especifica este campo o es una matriz vacía, todas las configuraciones de TaskOutputs se eliminan de forma predeterminada.
	object	No
Output	string	No	El identificador de salida.	pre.odps_sql_demo_0
Variables	array<object>	No	La lista de definiciones de variables. Si no se especifica este campo o es una matriz vacía, todas las configuraciones de Outputs.Variables se eliminan de forma predeterminada.
	object	No
Name	string	No	El nombre de la variable.	key1
Type	string	Sí	El tipo. Valores válidos: Constant: constante PassThrough: salida de un nodo de parámetro System: variable NodeOutput: salida del script	Constant
Value	string	No	El valor de la variable.	value1
Dependencies	array<object>	No	La información de dependencias. Si no se especifica este campo o es una matriz vacía, todas las configuraciones de Dependencies se eliminan de forma predeterminada.
	object	No
Type	string	Sí	El tipo de dependencia. Valores válidos: CrossCycleDependsOnChildren: dependencia entre ciclos en nodos secundarios de primer nivel CrossCycleDependsOnSelf: dependencia entre ciclos en el nodo actual CrossCycleDependsOnOtherNode: dependencia entre ciclos en otros nodos Normal: dependencia en el mismo ciclo	Normal
UpstreamOutput	string	No	El identificador de salida del nodo superior. Este campo se devuelve cuando el tipo de dependencia es `dependencia en el mismo ciclo` y se especifica el contenido de entrada.	pre.odps_sql_demo_0
UpstreamTaskId	integer	No	El ID del nodo superior. Este campo se devuelve cuando el tipo de dependencia es `dependencia entre ciclos en otros nodos` o `dependencia en el mismo ciclo` sin contenido de entrada especificado. No se devuelve en otros casos.	1234
Tags	array<object>	No	La lista de etiquetas del nodo. Si no se especifica este campo o es una matriz vacía, todas las configuraciones de Tags se eliminan de forma predeterminada.
	object	No
Key	string	Sí	La clave de la etiqueta.	key1
Value	string	No	El valor de la etiqueta.	value1
ClientUniqueCode	string	No	El código único de cliente del nodo, que se utiliza para operaciones asíncronas e idempotencia. Si no se especifica durante la creación, el sistema genera uno automáticamente y el código se vincula de forma única al ID del recurso. Si se especifica este parámetro durante la actualización o eliminación, debe ser coherente con el código único de cliente utilizado durante la creación.	Task_0bc5213917368545132902xxxxxxxx
EnvType	string	No	El entorno del proyecto. Valores válidos: Prod: producción Dev: desarrollo	Prod
Outputs	object	No	La información de salida.
TaskOutputs	array<object>	No	La lista de definiciones de salida de los nodos del flujo de trabajo.
	object	No
Output	string	No	El identificador de salida.	pre.odps_sql_demo_0
Tags	array<object>	No	La lista de etiquetas del flujo de trabajo.
	object	No
Key	string	Sí	La clave de la etiqueta.	key1
Value	string	No	El valor de la etiqueta.	value1
ClientUniqueCode	string	No	El código único de cliente del flujo de trabajo, que se utiliza para operaciones asíncronas e idempotencia. Si no se especifica durante la creación, el sistema genera uno automáticamente y el código se vincula de forma única al ID del recurso. Si se especifica este parámetro durante la actualización o eliminación, debe ser coherente con el código único de cliente utilizado durante la creación.	Workflow_0bc5213917368545132902xxxxxxxx
InstanceMode	string	No	El modo de generación de instancias. Valores válidos: T+1: Las instancias se generan al día siguiente. Immediately: Las instancias se generan de inmediato. Las instancias periódicas solo se generan si la hora programada del flujo de trabajo es al menos 10 minutos después de que se despliega el flujo de trabajo. Durante el periodo de generación completa de instancias (22:00 a 24:00), la generación de instancias en tiempo real no está disponible. Puede enviar y desplegar flujos de trabajo durante este periodo, pero las instancias no se regeneran después del envío. Valores válidos: Immediately : 立即生成 T+1 : 第二天生成	T+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
Success	boolean	Indica si la operación se realizó correctamente.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Success": true
}

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.