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

Actualiza un archivo existente.

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
FileFolderPath	string	No	La ruta donde se almacena el archivo.	Business_process/First_Business_Process/data_integration/Folder_1/Folder_2
ProjectId	integer	No	El ID del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks e ir a la página de Administración de espacios de trabajo para obtener el ID.	100001
FileName	string	No	El nombre del archivo. Puede cambiar el nombre del archivo restableciendo el valor de FileName. Por ejemplo, puede llamar a la operación ListFiles para consultar el ID de un archivo en el directorio de destino, llamar a la operación UpdateFile, especificar el ID de archivo consultado en el parámetro FileId y configurar el parámetro FileName para cambiar el nombre del archivo.	ods_user_info_d
FileDescription	string	No	La descripción del archivo.	Here is the file description
Content	string	No	El contenido de código del archivo. El formato del código varía según el tipo de archivo. Puede ir al Centro de operaciones, hacer clic derecho en una tarea del tipo correspondiente y seleccionar Ver código para ver el formato de código específico.	SELECT "1";
AutoRerunTimes	integer	No	El número de reejecuciones automáticas permitidas después de que se produce un error.	3
AutoRerunIntervalMillis	integer	No	El intervalo entre reejecuciones automáticas después de un error, en milisegundos. El valor máximo es 1800000, que equivale a 30 minutos. Este parámetro corresponde al parámetro Intervalo de reejecución en la sección Programación > Atributos de tiempo > Reejecución automática tras error de la consola de DataWorks. La unidad del parámetro Intervalo de reejecución en la consola es minutos. Convierta la unidad de tiempo al llamar a esta operación.	120000
RerunMode	string	No	El modo de reejecución. Valores válidos: ALL_ALLOWED: La tarea se puede reejecutar independientemente de si se ejecuta correctamente o falla. FAILURE_ALLOWED: La tarea solo se puede reejecutar después de que falla. ALL_DENIED: La tarea no se puede reejecutar independientemente de si se ejecuta correctamente o falla. Este parámetro corresponde al parámetro Modo de reejecución en la sección Programación > Atributos de tiempo de la consola de DataWorks. Valores válidos: ALL_ALLOWED : Todo permitido. ALL_DENIED : Todo denegado. ALL_ALLOWD : Todo permitido. FAILURE_ALLOWED : Permitido después de un error.	ALL_ALLOWED
Stop	boolean	No	Especifica si se debe pausar la programación. Valores válidos: true: Pausar la programación. false: No pausar la programación. Este parámetro corresponde a la opción Pausar programación en la sección Programación > Atributos de tiempo > Tipo de programación de la consola de DataWorks.	false
ParaValue	string	No	Los parámetros de programación. Este parámetro corresponde a la sección Parámetros de programación en la sección Programación de la consola de DataWorks. Para obtener más información, consulte Parámetros de programación.	x=a y=b z=c
StartEffectDate	integer	No	La hora de inicio de la programación automática, en forma de marca de tiempo en milisegundos. Este parámetro corresponde a la hora de inicio en la sección Programación > Atributos de tiempo > Fecha de vigencia de la consola de DataWorks.	936923400000
EndEffectDate	integer	No	La hora de finalización de la programación automática, en forma de marca de tiempo en milisegundos. Este parámetro corresponde a la hora de finalización en la sección Programación > Atributos de tiempo > Fecha de vigencia de la consola de DataWorks.	4155787800000
CronExpress	string	No	La expresión cron para la programación periódica. Este parámetro corresponde a la expresión cron en la sección Programación > Propiedad de tiempo para la tarea de desarrollo de datos en la consola de DataWorks. Después de configurar el ciclo de programación y la hora de programación programada, DataWorks genera automáticamente la expresión cron correspondiente. Ejemplos: Programar una tarea a las 05:30 todos los días: `00 30 05 * * ?`. Programar una tarea en el minuto 15 de cada hora: `00 15 * * * ?`. Programar una tarea cada 10 minutos: `00 00/10 * * * ?`. Programar una tarea cada 10 minutos de 08:00 a 17:00 todos los días: `00 00-59/10 8-23 * * * ?`. Programar una tarea a las 00:20 el primer día de cada mes: `00 20 00 1 * ?`. Programar una tarea cada tres meses a partir de las 00:10 del 1 de enero: `00 10 00 1 1-12/3 ?`. Programar una tarea a las 00:05 todos los martes y viernes: `00 05 00 * * 2,5`. Debido a las reglas del sistema de programación de DataWorks, las expresiones cron tienen los siguientes límites: El intervalo mínimo de programación es de 5 minutos. La hora de programación más temprana de un día es las 00:05.	00 00-59/5 1-23 * * ?
CycleType	string	No	El tipo de ciclo de programación. Valores válidos: NOT_DAY (minutos y horas) y DAY (días, semanas y meses). Este parámetro corresponde al parámetro Tipo de programación en la sección Programación > Atributos de tiempo de la consola de DataWorks. Valores válidos: NOT_DAY : Minutos y horas. DAY : Días, semanas y meses.	NOT_DAY
DependentType	string	No	La dependencia del ciclo anterior. Valores válidos: SELF: El nodo actual. CHILD: Los nodos secundarios en el primer nivel. USER_DEFINE: Otros nodos. NONE: Sin dependencia del ciclo anterior. Valores válidos: CHILD_AND_SELF : Nodo actual y nodos descendentes. USER_DEFINE : Nodos especificados. SELF : Nodo actual. USER_DEFINE_AND_SELF : Nodos especificados y nodo actual. NONE : Ninguna. CHILD : Nodos descendentes.	USER_DEFINE
DependentNodeIdList	string	No	Los ID de los nodos de los que depende el archivo actual cuando la configuración del parámetro DependentType se establece en USER_DEFINE. Separe varios ID de nodo con comas (,). Este parámetro corresponde al contenido configurado cuando establece el parámetro Dependencia en Dependencia entre ciclos (Ciclo anterior) y selecciona Otros nodos en la sección Programación > Dependencias de programación para el nodo de desarrollo de datos en la consola de DataWorks.	5,10,15,20
InputList	string	No	Los nombres de salida de los archivos ascendentes de los que depende el archivo actual. Separe varios nombres de salida con comas (,). Este parámetro corresponde al parámetro Nombre de salida del nodo ascendente en la sección Programación > Dependencias de programación de la consola de DataWorks. Nota Este parámetro es obligatorio cuando se crea una tarea de sincronización sin conexión llamando a la operación CreateDISyncTask o UpdateFile.	project_root,project.file1,project.001_out
ProjectIdentifier	string	No	El nombre del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks e ir a la página de Configuración del espacio de trabajo para obtener el nombre del espacio de trabajo. Debe especificar este parámetro o el parámetro ProjectId para determinar el espacio de trabajo de DataWorks para esta llamada a la API.	dw_project
FileId	integer	Sí	El ID del archivo. Puede llamar a la operación ListFiles para obtener el ID del archivo.	100000001
OutputList	string	No	La salida del archivo. Este parámetro corresponde al parámetro Nombre de salida del nodo actual en la sección Programación > Dependencias de programación de la consola de DataWorks.	dw_project.ods_user_info_d
ResourceGroupIdentifier	string	No	El grupo de recursos que se utiliza cuando se ejecuta la tarea después de que el archivo se publica como tarea. Puede llamar a la operación ListResourceGroups para obtener la lista de grupos de recursos disponibles en el espacio de trabajo.	default_group
ConnectionName	string	No	El identificador del origen de datos que se utiliza cuando se ejecuta la tarea correspondiente al archivo. Puede llamar a la operación ListDataSources para obtener la lista de orígenes de datos disponibles.	odps_source
Owner	string	No	El ID de usuario del propietario del archivo.	18023848927592
AutoParsing	boolean	No	Especifica si se debe habilitar la función de análisis automático para el archivo. Valores válidos: true: El archivo analiza el código automáticamente. false: El archivo no analiza el código automáticamente. Este parámetro corresponde al parámetro Análisis de código en la sección Programación > Dependencias de programación de la consola de DataWorks.	true
SchedulerType	string	No	El tipo de programación. Valores válidos: NORMAL: Tarea de programación normal. MANUAL: Tarea manual. No se programa a diario y corresponde a un nodo en un flujo de trabajo manual. PAUSE: Tarea pausada. SKIP: Tarea de ejecución de prueba. Se programa a diario, pero su estado se establece directamente como correcta cuando se activa la programación. Valores válidos: PAUSE : Tarea pausada. SKIP : Tarea de ejecución de prueba. Se programa a diario, pero su estado se establece directamente como correcta cuando se activa la programación. MANUAL : Tarea manual. No se programa a diario y corresponde a un nodo en un flujo de trabajo manual. NORMAL : Tarea de programación normal.	NORMAL
AdvancedSettings	string	No	La configuración avanzada de la tarea. Este parámetro corresponde a la sección Configuración avanzada en el panel de navegación derecho de la página de edición para las tareas de desarrollo de datos EMR Spark Streaming y EMR Streaming SQL en la consola de DataWorks. Actualmente, solo las tareas EMR Spark Streaming y EMR Streaming SQL admiten este parámetro, y el valor del parámetro debe estar en formato JSON.	{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}
StartImmediately	boolean	No	Especifica si se debe iniciar la tarea inmediatamente después de su publicación. Valores válidos: true: Iniciar la tarea inmediatamente después de su publicación. false: No iniciar la tarea inmediatamente después de su publicación. Este parámetro corresponde al parámetro Método de inicio en la sección Configuración > Atributos de tiempo en el panel de navegación derecho de la página de edición para las tareas de desarrollo de datos EMR Spark Streaming y EMR Streaming SQL en la consola de DataWorks.	true
InputParameters	string	No	Los parámetros de entrada de contexto del nodo. El valor del parámetro está en formato JSON. Para los campos incluidos, consulte la estructura del parámetro InputContextParameterList en la respuesta de la operación GetFile. Este parámetro corresponde al parámetro Parámetros de entrada del nodo actual en la sección Programación > Parámetros de contexto del nodo de la consola de DataWorks.	[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]
OutputParameters	string	No	Los parámetros de salida de contexto del nodo. El valor del parámetro está en formato JSON. Para los campos incluidos, consulte la estructura del parámetro OutputContextParameterList en la respuesta de la operación GetFile. Este parámetro corresponde al parámetro Parámetros de salida del nodo actual en la sección Programación > Parámetros de contexto del nodo de la consola de DataWorks.	[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]
IgnoreParentSkipRunningProperty	boolean	No	Este parámetro corresponde al parámetro Omitir ejecución de prueba de nodos ascendentes que se configura cuando establece el parámetro Dependencia en Dependencia entre ciclos (Ciclo anterior) y selecciona Nodo actual o Nodos secundarios en el primer nivel en la sección Programación > Dependencias de programación de la consola de DataWorks.	true
ApplyScheduleImmediately	boolean	No	Especifica si la configuración de programación surte efecto inmediatamente después de que se publica el archivo.	true
Timeout	integer	No	La definición de tiempo de espera en la configuración de programación.	1
ImageId	string	No	El ID de la imagen personalizada.	m-uf6d7npxk1hhek8ng0cb

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El resultado devuelto.
HttpStatusCode	integer	El código de estado HTTP.	200
ErrorMessage	string	El mensaje de error.	The connection does not exist.
RequestId	string	El ID único de la solicitud. Puede utilizar el ID para solucionar problemas cuando se produce un error.	0000-ABCD-EFGH-IJKLMNOPQ
ErrorCode	string	El código de error.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica si la llamada se realizó correctamente. Valores válidos: true: La llamada se realizó correctamente. false: La llamada falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFGH-IJKLMNOPQ",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No tiene los permisos requeridos. Conceda los permisos primero.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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.