UpdateFile - - Centro de documentación de Alibaba Cloud

Actualiza un archivo.

Cuando depura o invoca esta operación, debe especificar nuevos valores para los parámetros de un nodo. Por ejemplo, si el valor original de un parámetro es A, debe cambiarlo a B antes de confirmar el nodo. Si establece el parámetro en A, se produce una excepción que indica datos no válidos.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que invoque esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	UpdateFile	La operación que desea ejecutar.
FileFolderPath	String	No	Workflow/1/Data Integration/Folder 1/Folder 2	La ruta del archivo.
ProjectId	Long	No	10000	El ID del espacio de trabajo de DataWorks. Inicie sesión en la DataWorks console y vaya a la página Workspace para obtener el ID del espacio de trabajo.
FileName	String	No	ods_user_info_d	El nombre del archivo. Establezca el parámetro FileName en otro valor para cambiar el nombre del archivo. Invoque la operación ListFiles para consultar el ID del archivo cuyo nombre desea cambiar. Luego, invoque la operación UpdateFile para cambiar el nombre del archivo al establecer el parámetro FileId en el ID consultado y configurar el parámetro FileName con un nuevo valor.
FileDescription	String	No	Descripción del archivo	La descripción del archivo.
Content	String	No	SELECT "1";	El código del archivo. El formato del código varía según el tipo de archivo. Para ver el formato de código de un tipo específico, vaya a Operation Center, abra el DAG de un nodo de ese tipo, haga clic derecho en el nodo y seleccione View Code.
AutoRerunTimes	Integer	Sí	3	El número de reejecuciones automáticas permitidas después de que ocurre un error.
AutoRerunIntervalMillis	Integer	No	120000	El intervalo entre reejecuciones automáticas después de que ocurre un error. Unidad: milisegundo. Valor máximo: 1800000 (30 minutos). Este parámetro corresponde al parámetro Rerun interval que se muestra después de seleccionar la casilla Auto Rerun upon Error en la sección Schedule de la pestaña Properties en la DataWorks console. El intervalo que especifique en la consola de DataWorks se mide en minutos. Preste atención a la conversión entre unidades de tiempo cuando invoque la operación.
RerunMode	String	No	ALL_ALLOWED	Especifica si el nodo correspondiente al archivo se puede reejecutar. Valores válidos: ALL_ALLOWED: El nodo se puede reejecutar independientemente de si se ejecutó correctamente o falló. FAILURE_ALLOWED: El nodo solo se puede reejecutar después de fallar. ALL_DENIED: El nodo no se puede reejecutar independientemente de si se ejecutó correctamente o falló. Este parámetro corresponde al parámetro Rerun en la sección Schedule de la pestaña Properties en la DataWorks console.
Stop	Boolean	No	false	Especifica si se debe suspender la programación del nodo. Valores válidos: true false Este parámetro corresponde al parámetro Recurrence en la sección Schedule de la pestaña Properties en la DataWorks console.
ParaValue	String	No	x=a y=b z=c	Los parámetros de programación del nodo. Este parámetro corresponde a la sección Scheduling Parameter de la pestaña Properties en la DataWorks console. Para más información sobre las configuraciones de los parámetros de programación, consulte Configure scheduling parameters.
StartEffectDate	Long	No	936923400000	La hora de inicio de la programación automática. Establezca el valor como una marca de tiempo UNIX que represente el número de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC. Este parámetro corresponde a la hora de inicio especificada para el parámetro Validity Period en la sección Schedule de la pestaña Properties en la DataWorks console.
EndEffectDate	Long	No	4155787800000	La hora de finalización de la programación automática. Establezca el valor como una marca de tiempo UNIX que represente el número de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC. Este parámetro corresponde a la hora de finalización especificada para el parámetro Validity Period en la sección Schedule de la pestaña Properties en la DataWorks console.
CronExpress	String	No	00 00-59/5 1-23 ?	La expresión CRON que representa la directiva de programación periódica del nodo. Este parámetro corresponde al parámetro Cron Expression en la sección Schedule de la pestaña Properties en la DataWorks console. Después de configurar los parámetros Scheduling Cycle y Scheduled time en la consola de DataWorks, el sistema genera el valor del parámetro Cron Expression. Ejemplos: Expresión CRON para un nodo programado para ejecutarse a las 05:30 todos los días: `00 30 05 ?` Expresión CRON para un nodo programado para ejecutarse en el minuto quince de cada hora: `00 15 * ?` Expresión CRON para un nodo programado para ejecutarse cada 10 minutos: `00 00/10 * ?` Expresión CRON para un nodo programado para ejecutarse cada 10 minutos de 08:00 a 17:00 todos los días: `00 00-59/10 8-23 * ?` Expresión CRON para un nodo programado para ejecutarse a las 00:20 el primer día de cada mes: `00 20 00 1 * ?` Expresión CRON para un nodo programado para ejecutarse cada tres meses a partir de las 00:10 del 1 de enero: `00 10 00 1 1-12/3 ?` Expresión CRON para un nodo programado para ejecutarse a las 00:05 cada martes y viernes: `00 05 00 2,5` El sistema de programación de DataWorks impone los siguientes límites a las expresiones CRON: El intervalo mínimo especificado en una expresión CRON para programar un nodo es de 5 minutos. La hora más temprana a la que se puede programar un nodo diariamente es a las 00:05.
CycleType	String	No	NOT_DAY	El tipo de ciclo de programación del nodo correspondiente al archivo. Valores válidos: NOT_DAY y DAY. El valor NOT_DAY indica que el nodo está programado para ejecutarse por minuto u hora. El valor DAY indica que el nodo está programado para ejecutarse por día, semana o mes. Este parámetro corresponde al parámetro Scheduling Cycle en la sección Schedule de la pestaña Properties en la DataWorks console.
DependentType	String	No	USER_DEFINE	El tipo de dependencia de programación entre ciclos del nodo. Valores válidos: SELF: La instancia generada para el nodo en el ciclo actual depende de la instancia generada para el nodo en el ciclo anterior. CHILD: La instancia generada para el nodo en el ciclo actual depende de las instancias generadas para los nodos descendientes en el nivel más cercano del nodo en el ciclo anterior. USER_DEFINE: La instancia generada para el nodo en el ciclo actual depende de las instancias generadas para uno o más nodos específicos en el ciclo anterior. NONE: No se ha seleccionado ningún tipo de dependencia de programación entre ciclos para el nodo.
DependentNodeIdList	String	No	5,10,15,20	El ID del nodo del cual depende el nodo correspondiente al archivo cuando el parámetro DependentType se establece en USER_DEFINE. Separe varios IDs con comas (,). El valor de este parámetro corresponde al ID del nodo que especificó después de seleccionar Previous Cycle y establecer Depend On en Other Nodes en la sección Dependencies de la pestaña Properties en la DataWorks console.
InputList	String	No	project_root,project.file1,project.001_out	El nombre de salida del archivo principal del cual depende el archivo actual. Si especifica varios nombres de salida, sepárelos con comas (,). Este parámetro corresponde al parámetro Parent Nodes que se muestra después de seleccionar Same Cycle en la sección Dependencies de la pestaña Properties en la DataWorks console.
ProjectIdentifier	String	No	dw_project	El nombre del espacio de trabajo de DataWorks. Inicie sesión en la DataWorks console y vaya a la página Workspace para obtener el nombre del espacio de trabajo. Debe configurar este parámetro o el parámetro ProjectId para determinar el espacio de trabajo de DataWorks al que se aplica la operación.
FileId	Long	Sí	100000001	El ID del archivo. Invoque la operación ListFiles para obtener el ID.
OutputList	String	No	dw_project.ods_user_info_d	El nombre de salida del archivo actual. Este parámetro corresponde al parámetro Output en la sección Dependencies de la pestaña Properties en la DataWorks console.
ResourceGroupIdentifier	String	No	default_group	El identificador del resource group utilizado para ejecutar el nodo correspondiente al archivo. Invoque la operación ListResourceGroups para consultar los resource groups disponibles en el espacio de trabajo.
ConnectionName	String	No	odps_source	El nombre del origen de datos utilizado para ejecutar el nodo. Invoque la operación ListDataSources para consultar los orígenes de datos disponibles del espacio de trabajo.
Owner	String	No	18023848927592	El ID del propietario del archivo.
AutoParsing	Boolean	No	true	Especifica si se debe habilitar la función de análisis automático para el archivo. Valores válidos: true false Este parámetro corresponde al parámetro Automatic Parsing From Code Before Node Committing que se muestra después de seleccionar Same Cycle en la sección Dependencies de la pestaña Properties en la DataWorks console.
SchedulerType	String	No	NORMAL	El tipo de programación del nodo. Valores válidos: NORMAL: El nodo es un nodo de activación automática. MANUAL: El nodo es un nodo de activación manual. Los nodos de activación manual no pueden activarse automáticamente. Corresponden a los nodos en el panel Manually Triggered Workflows. PAUSE: El nodo es un nodo pausado. SKIP: El nodo es un nodo de ejecución simulada. Los nodos de ejecución simulada se inician según lo programado, pero el sistema de programación establece su estado como exitoso cuando comienza a ejecutarlos.
AdvancedSettings	String	No	{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}	Las configuraciones avanzadas del nodo. Este parámetro solo es válido para un nodo EMR Spark Streaming o un nodo EMR Streaming SQL. Corresponde a la pestaña Advanced Settings del nodo en la DataWorks console. El valor de este parámetro debe estar en formato JSON.
StartImmediately	Boolean	No	true	Especifica si se debe ejecutar inmediatamente un nodo después de desplegarlo en el entorno de producción. Valores válidos: true false Este parámetro solo es válido para un nodo EMR Spark Streaming o un nodo EMR Streaming SQL. Corresponde al parámetro Start Method en la sección Schedule de la pestaña Configure en la DataWorks console.
InputParameters	String	No	[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]	Los parámetros de entrada del nodo. El valor de este parámetro debe estar en formato JSON. Para más información sobre los parámetros de entrada, consulte el parámetro InputContextParameterList en la sección Response parameters de la operación GetFile. Este parámetro corresponde a la tabla Input Parameters en la sección Input and Output Parameters de la pestaña Properties en la DataWorks console.
OutputParameters	String	No	[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]	Los parámetros de salida del nodo. El valor de este parámetro debe estar en formato JSON. Para más información sobre los parámetros de salida, consulte el parámetro OutputContextParameterList en la sección Response parameters de la operación GetFile. Este parámetro corresponde a la tabla Output Parameters en la sección Input and Output Parameters de la pestaña Properties en la DataWorks console.
IgnoreParentSkipRunningProperty	Boolean	No	true	Especifica si se debe omitir la propiedad de ejecución simulada de los nodos antecesores del nodo. Este parámetro corresponde al parámetro Skip the dry-run property of the ancestor node que se muestra después de configurar el parámetro Depend On en la sección Dependencies de la pestaña Properties en la consola de DataWorks.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
HttpStatusCode	Integer	200	El código de estado HTTP.
ErrorMessage	String	The connection does not exist.	El mensaje de error.
RequestId	String	0000-ABCD-EFGH-IJKLMNOPQ	El ID de la solicitud.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	El código de error.
Success	Boolean	true	Indica si la solicitud fue exitosa. Valores válidos: true false

Ejemplos

Solicitudes de ejemplo

http(s)://[Endpoint]/?Action=UpdateFile
&FileFolderPath=Workflow/1/Data Integration/Folder 1/Folder 2
&ProjectId=10000
&FileName=ods_user_info_d
&FileDescription=File description
&Content=SELECT "1";
&AutoRerunTimes=3
&AutoRerunIntervalMillis=120000
&RerunMode=ALL_ALLOWED
&Stop=false
&ParaValue=x=a y=b z=c
&StartEffectDate=936923400000
&EndEffectDate=4155787800000
&CronExpress=00 00-59/5 1-23 * * ?
&CycleType=NOT_DAY
&DependentType=USER_DEFINE
&DependentNodeIdList=5,10,15,20
&InputList=project_root,project.file1,project.001_out
&ProjectIdentifier=dw_project
&FileId=100000001
&OutputList=dw_project.ods_user_info_d
&ResourceGroupIdentifier=default_group
&ConnectionName=odps_source
&Owner=18023848927592
&AutoParsing=true
&SchedulerType=NORMAL
&AdvancedSettings={"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}
&StartImmediately=true
&InputParameters=[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]
&OutputParameters=[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]
&IgnoreParentSkipRunningProperty=true
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateFileResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <RequestId>0000-ABCD-EFGH-IJKLMNOPQ</RequestId>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
</UpdateFileResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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
429	Throttling.Api	The request for this resource has exceeded your available limit.	El número de solicitudes para el recurso ha excedido el límite superior.
429	Throttling.System	The DataWorks system is busy. Try again later.	El sistema de DataWorks está ocupado. Inténtelo de nuevo más tarde.
429	Throttling.User	Your request is too frequent. Try again later.	Se han enviado demasiadas solicitudes en un periodo corto. Inténtelo de nuevo más tarde.
500	InternalError.System	An internal system error occurred. Try again later.	Ocurrió un error interno del sistema. Inténtelo de nuevo más tarde.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Ocurrió un error interno del sistema. Inténtelo de nuevo más tarde.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.