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

Actualiza un archivo existente.

Descripción de la operación

Al depurar o invocar esta operación, los parámetros que especifique deben ser diferentes de las configuraciones de archivo originales del nodo. Por ejemplo, si el valor de un parámetro para el nodo de origen es A, debe cambiarlo a B antes de enviar la solicitud. Si aún especifica A, se notifica una excepción no válida.

Requisitos previos: Antes de invocar esta operación, debe activar DataWorks Enterprise Edition o Ultimate Edition. Si no se cumplen los requisitos de la edición, la operación devuelve un error 403 Forbidden.Access.

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

update

*All resources.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
FileFolderPath	string	No	La ruta del 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 gestió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 invocar la operación ListFiles para consultar el ID de un archivo en el directorio de destino, invocar 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 del código del archivo. El formato del código varía según el tipo de archivo (fileType). 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 para las reejecuciones automáticas después de que se produce un error. Unidad: milisegundos. Valor máximo: 1800000 (30 minutos). Este parámetro corresponde a la configuración de Intervalo de reejecución en Configuración de programación > Atributos de tiempo > Reejecución automática tras error para una tarea de desarrollo de datos en la consola de DataWorks. La unidad para el Intervalo de reejecución en la consola es minutos. Asegúrese de convertir el tiempo al invocar la operación.	120000
RerunMode	string	No	El atributo de reejecución. Valores válidos: ALL_ALLOWED: La tarea se puede reejecutar después de que se ejecuta correctamente o falla. FAILURE_ALLOWED: La tarea no se puede reejecutar después de que se ejecuta correctamente, pero 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 a la configuración de Atributo de reejecución en Configuración de programación > Atributos de tiempo para una tarea de desarrollo de datos en la consola de DataWorks. Valores válidos: ALL_ALLOWED : La tarea se puede reejecutar después de que se ejecuta correctamente o falla. ALL_DENIED : La tarea no se puede reejecutar independientemente de si se ejecuta correctamente o falla. ALL_ALLOWD : La tarea se puede reejecutar después de que se ejecuta correctamente o falla. FAILURE_ALLOWED : La tarea solo se puede reejecutar después de que falla.	ALL_ALLOWED
Stop	boolean	No	Especifica si se debe pausar la programación. Valores válidos: true: Pausa la programación. false: No pausa la programación. Este parámetro corresponde a la configuración de Pausar programación en Configuración de programación > Atributos de tiempo > Tipo de programación para una tarea de desarrollo de datos en la consola de DataWorks.	false
ParaValue	string	No	Los parámetros de programación. Este parámetro corresponde a la configuración de Parámetros en Configuración de programación para una tarea de desarrollo de datos en 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 marca de tiempo en milisegundos en la que comienza la programación automática. Este parámetro corresponde a la hora de inicio en milisegundos configurada en Configuración de programación > Atributos de tiempo > Fecha de vigencia para una tarea de desarrollo de datos en la consola de DataWorks.	936923400000
EndEffectDate	integer	No	La marca de tiempo en milisegundos en la que se detiene la programación automática. Este parámetro corresponde a la hora de finalización en milisegundos configurada en Configuración de programación > Atributos de tiempo > Fecha de vigencia para una tarea de desarrollo de datos en la consola de DataWorks.	4155787800000
CronExpress	string	No	La expresión cron para la programación periódica. Este parámetro corresponde a la configuración de Expresión cron en Configuración de programación > Propiedad de tiempo para una tarea de desarrollo de datos en la consola de DataWorks. Después de configurar el ciclo de programación y la hora 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 3 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 todos los días es a las 00:05.	00 00-59/5 1-23 * * ?
CycleType	string	No	El tipo de ciclo de programación. Valores válidos: NOT_DAY (minuto u hora) y DAY (día, semana o mes). Este parámetro corresponde a la configuración de Ciclo de programación en Configuración de programación > Atributos de tiempo para una tarea de desarrollo de datos en la consola de DataWorks. Valores válidos: NOT_DAY : Programa la tarea por minuto u hora. DAY : Programa la tarea por día, semana o mes.	NOT_DAY
DependentType	string	No	La dependencia del ciclo anterior. Valores válidos: SELF: Depende del nodo actual. CHILD: Depende de los nodos secundarios en el primer nivel. USER_DEFINE: Depende de otros nodos. NONE: No depende del ciclo anterior. Valores válidos: CHILD_AND_SELF : Depende de los nodos secundarios en el primer nivel y del nodo actual. USER_DEFINE : Depende de otros nodos. SELF : Depende del nodo actual. USER_DEFINE_AND_SELF : Depende de otros nodos y del nodo actual. NONE : No depende del ciclo anterior. CHILD : Depende de los nodos secundarios en el primer nivel.	USER_DEFINE
DependentNodeIdList	string	No	Los ID de los nodos de los que depende el archivo actual. Este parámetro es obligatorio cuando el parámetro DependentType se establece en USER_DEFINE. Separe varios ID de nodo con comas (,). Este parámetro corresponde al contenido configurado cuando establece Dependencias de programación en Configuración de programación > Ciclo anterior y selecciona Otros nodos para un 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. Separe varios nombres de salida con comas (,). Este parámetro corresponde a la configuración de Nombre de salida del nodo primario cuando selecciona Mismo ciclo en Configuración de programación > Dependencias de programación para una tarea de desarrollo de datos en la consola de DataWorks. Nota Este parámetro es obligatorio cuando se crea una tarea de sincronización sin conexión al invocar 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 invocar la operación ListFiles para obtener el ID del archivo.	100000001
OutputList	string	No	La salida del archivo. Este parámetro corresponde a la configuración de Nombre de salida del nodo actual cuando selecciona Mismo ciclo en Configuración de programación > Dependencias de programación para una tarea de desarrollo de datos en 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 invocar 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 invocar 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: Analiza el código automáticamente. false: No analiza el código automáticamente. Este parámetro corresponde a la configuración de Análisis de código cuando selecciona Mismo ciclo en Configuración de programación > Dependencias de programación para una tarea de desarrollo de datos en la consola de DataWorks.	true
SchedulerType	string	No	El tipo de programación. Valores válidos: NORMAL: Una tarea de programación normal. MANUAL: Una tarea manual que no se programa a diario. Corresponde a un nodo bajo un flujo de trabajo manual. PAUSE: Una tarea pausada. SKIP: Una tarea de ejecución de prueba que se programa a diario, pero que se establece directamente como correcta cuando comienza la programación. Valores válidos: PAUSE : Una tarea pausada. SKIP : Una tarea de ejecución de prueba que se programa a diario, pero que se establece directamente como correcta cuando comienza la programación. MANUAL : Una tarea manual que no se programa a diario. Corresponde a un nodo bajo un flujo de trabajo manual. NORMAL : Una tarea de programación normal.	NORMAL
AdvancedSettings	string	No	La configuración avanzada de la tarea. Este parámetro corresponde a la 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. 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 que se publica. Valores válidos: true: Inicia la tarea inmediatamente después de que se publica. false: No inicia la tarea inmediatamente después de que se publica. Este parámetro corresponde a la configuración de Método de inicio en 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 debe estar 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 a la configuración de Parámetros de entrada del nodo actual en Configuración de programación > Contexto del nodo para una tarea de desarrollo de datos en 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 debe estar 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 a la configuración de Parámetros de salida del nodo actual en Configuración de programación > Contexto del nodo para una tarea de desarrollo de datos en la consola de DataWorks.	[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]
IgnoreParentSkipRunningProperty	boolean	No	Especifica si se debe omitir la propiedad de ejecución de prueba de los nodos ascendentes en el ciclo anterior.	true
ApplyScheduleImmediately	boolean	No	Especifica si las configuraciones de programación surten efecto inmediatamente después de que se publica la tarea.	true
Timeout	integer	No	La configuración de tiempo de espera en las configuraciones 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	La respuesta.
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 si 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.