Call the UpdateFile API to update a file - DataWorks - Alibaba Cloud - DataWorks

Updates an existing file.

Operation description

When you debug or call this operation, the parameters you specify must be different from the original file configurations of the node. For example, if the value of a parameter for the source node is A, you must change the value to B before you submit the request. If you still specify A, an invalid exception is reported.

DataWorks Basic Edition and later are supported.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FileFolderPath	string	No	The path of the file.	Business_process/First_Business_Process/data_integration/Folder_1/Folder_2
ProjectId	integer	No	The ID of the DataWorks workspace. You can logon to the DataWorks console and go to the workspace storage management page to obtain the ID.	100001
FileName	string	No	The name of the file. You can change the file name by resetting the value of FileName. For example, you can call the ListFiles operation to query the ID of a file in the destination directory, and then call the UpdateFile operation. Set the FileId parameter to the queried file ID and specify the FileName parameter to change the name of the file.	ods_user_info_d
FileDescription	string	No	The description of the file.	Here is the file description
Content	string	No	The code content of the file. The code format varies based on the file type. You can go to Operation Center, right-click a task of the corresponding type, and select View Code to view the specific code format.	SELECT "1";
AutoRerunTimes	integer	No	The number of automatic reruns after an error occurs.	3
AutoRerunIntervalMillis	integer	No	The interval for automatic reruns after an error occurs. Unit: milliseconds. Maximum value: 1800000, which equals 30 minutes. This parameter corresponds to the Rerun Interval parameter in the Schedule > Time Attributes > Automatic Rerun after Error section of the DataWorks console. The unit of the Rerun Interval parameter in the console is minutes. Convert the time unit when you call this operation. DataWorks console	120000
RerunMode	string	No	The rerun mode. Valid values: ALL_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run. FAILURE_ALLOWED: The node cannot be rerun if it is successfully run, but can be rerun if it fails to run. ALL_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run. This parameter corresponds to the Rerun Mode parameter in the Schedule > Time Attributes > Rerun Mode section of the DataWorks console. DataWorks console Valid values: ALL_ALLOWED : The node can be rerun regardless of whether it is successfully run or fails to run. ALL_DENIED : The node cannot be rerun regardless of whether it is successfully run or fails to run. ALL_ALLOWD : The node can be rerun regardless of whether it is successfully run or fails to run. FAILURE_ALLOWED : The node can be rerun only if it fails to run.	ALL_ALLOWED
Stop	boolean	No	Specifies whether to pause scheduling. Valid values: true: Pause scheduling. false: Do not pause scheduling. This parameter corresponds to the Pause Scheduling option in the Schedule > Time Attributes > Schedule Type section of the DataWorks console. DataWorks console	false
ParaValue	string	No	The scheduling parameters. This parameter corresponds to the Parameters section in the Schedule > Parameters section of the DataWorks console. For more information, see Scheduling parameters. DataWorks console	x=a y=b z=c
StartEffectDate	integer	No	The timestamp in milliseconds when automatic scheduling starts. This parameter corresponds to the start time of the Effective Date parameter in the Schedule > Time Attributes > Effective Date section of the DataWorks console. DataWorks console	936923400000
EndEffectDate	integer	No	The timestamp in milliseconds when automatic scheduling stops. This parameter corresponds to the end time of the Effective Date parameter in the Schedule > Time Attributes > Effective Date section of the DataWorks console. DataWorks console	4155787800000
CronExpress	string	No	The cron expression for periodic scheduling. This parameter corresponds to the Cron Expression parameter in the Schedule > Time Property > Cron Expression section of the DataWorks console. After you configure the scheduling cycle and scheduled time, DataWorks automatically generates the corresponding cron expression. Examples: Schedule a node at 05:30 every day: `00 30 05 * * ?`. Schedule a node at the 15th minute of every hour: `00 15 * * * ?`. Schedule a node every 10 minutes: `00 00/10 * * * ?`. Schedule a node every 10 minutes from 08:00 to 17:00 every day: `00 00-59/10 8-23 * * * ?`. Schedule a node at 00:20 on the first day of every month: `00 20 00 1 * ?`. Schedule a node every three months starting from 00:10 on January 1: `00 10 00 1 1-12/3 ?`. Schedule a node at 00:05 every Tuesday and Friday: `00 05 00 * * 2,5`. Due to the rules of the DataWorks scheduling system, cron expressions have the following limits: The minimum scheduling interval is 5 minutes. The earliest scheduling time of a day is 00:05.	00 00-59/5 1-23 * * ?
CycleType	string	No	The type of the scheduling cycle. Valid values: NOT_DAY (minute and hour) and DAY (day, week, and month). This parameter corresponds to the Scheduling Cycle parameter in the Schedule > Time Attributes > Scheduling Cycle section of the DataWorks console. DataWorks console Valid values: NOT_DAY : Scheduling by minute or hour. DAY : Scheduling by day, week, or month.	NOT_DAY
DependentType	string	No	The dependency on the previous cycle. Valid values: SELF: The node depends on itself. CHILD: The node depends on its level-1 child nodes. USER_DEFINE: The node depends on other nodes. NONE: The node does not depend on the previous cycle. Valid values: CHILD_AND_SELF : Depends on level-1 child nodes and the current node. USER_DEFINE : Depends on other nodes. SELF : Depends on the current node. USER_DEFINE_AND_SELF : Depends on other nodes and the current node. NONE : Does not depend on the previous cycle. CHILD : Depends on level-1 child nodes.	USER_DEFINE
DependentNodeIdList	string	No	The IDs of the nodes on which the current file depends. This parameter is used to specify the dependent node IDs when the DependentType parameter is set to USER_DEFINE. Separate multiple node IDs with commas (,). This parameter corresponds to the content configured when the Schedule > Scheduling Dependencies parameter is set to Previous Cycle and the dependent item is set to Other Nodes for a data development node in the DataWorks console.	5,10,15,20
InputList	string	No	The output names of the upstream files on which the current file depends. Separate multiple output names with commas (,). This parameter corresponds to the Parent Node Output Name parameter in the Schedule > Scheduling Dependencies > Same Cycle section of the DataWorks console. Note This parameter is required when you create an offline synchronization task by calling the CreateDISyncTask and UpdateFile operations. DataWorks console	project_root,project.file1,project.001_out
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Configuration page to obtain the workspace name. You must specify either this parameter or the ProjectId parameter to determine the DataWorks workspace for this API call.	dw_project
FileId	integer	Yes	The ID of the file. You can call the ListFiles operation to obtain the file ID.	100000001
OutputList	string	No	The output of the file. This parameter corresponds to the Output Name of Current Node parameter in the Schedule > Scheduling Dependencies > Same Cycle section of the DataWorks console. DataWorks console	dw_project.ods_user_info_d
ResourceGroupIdentifier	string	No	The resource group used to run the task after the file is published as a task. You can call the ListResourceGroups operation to obtain the list of available resource groups in the workspace.	default_group
ConnectionName	string	No	The identifier of the data source used by the task when the task corresponding to the file is run. You can call the ListDataSources operation to obtain the list of available data sources.	odps_source
Owner	string	No	The user ID of the file owner.	18023848927592
AutoParsing	boolean	No	Specifies whether to enable the automatic parsing feature for the file. Valid values: true: The file automatically parses code. false: The file does not automatically parse code. This parameter corresponds to the Code Parsing option in the Schedule > Scheduling Dependencies > Same Cycle section of the DataWorks console. DataWorks console	true
SchedulerType	string	No	The scheduling type. Valid values: NORMAL: Normal scheduling task. MANUAL: Manual task. The task is not run on a daily schedule and corresponds to a node in a manual workflow. PAUSE: Paused task. SKIP: Dry-run task. The task is run on a daily schedule, but its status is directly set to successful when the scheduling is started. Valid values: PAUSE : Paused task. SKIP : Dry-run task. The task is run on a daily schedule, but its status is directly set to successful when the scheduling is started. MANUAL : Manual task. The task is not run on a daily schedule and corresponds to a node in a manual workflow. NORMAL : Normal scheduling task.	NORMAL
AdvancedSettings	string	No	The advanced settings of the task. This parameter corresponds to the Advanced Settings section in the right-side navigation pane of the edit page for EMR Spark Streaming and EMR Streaming SQL data development tasks in the DataWorks console. Only EMR Spark Streaming and EMR Streaming SQL tasks support this parameter. The parameter value must be in JSON format. DataWorks console	{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}
StartImmediately	boolean	No	Specifies whether to start the task immediately after it is published. Valid values: true: Start the task immediately after it is published. false: Do not start the task immediately after it is published. This parameter corresponds to the Start Mode parameter in the Configuration > Time Attributes > Start Mode section in the right-side navigation pane of the edit page for EMR Spark Streaming and EMR Streaming SQL data development tasks in the DataWorks console. DataWorks console	true
InputParameters	string	No	The context input parameters of the node. The parameter value must be in JSON format. For the fields included, refer to the InputContextParameterList parameter structure in the response of the GetFile operation. This parameter corresponds to the Input Parameters of Current Node parameter in the Schedule > Node Context > Input Parameters section of the DataWorks console. DataWorks console	[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]
OutputParameters	string	No	The context output parameters of the node. The parameter value must be in JSON format. For the fields included, refer to the OutputContextParameterList parameter structure in the response of the GetFile operation. This parameter corresponds to the Output Parameters of Current Node parameter in the Schedule > Node Context > Output Parameters section of the DataWorks console. DataWorks console	[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]
IgnoreParentSkipRunningProperty	boolean	No	Specifies whether to skip the dry-run property of upstream nodes in the previous cycle.	true
ApplyScheduleImmediately	boolean	No	Specifies whether the scheduling configurations take effect immediately after the file is published.	true
Timeout	integer	No	The timeout definition in the scheduling configurations.	1
ImageId	string	No	The ID of the custom image.	m-uf6d7npxk1hhek8ng0cb

Response elements

Element	Type	Description	Example
	object	The response.
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The unique ID of the request. You can use the ID to troubleshoot issues when an error occurs.	0000-ABCD-EFGH-IJKLMNOPQ
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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 permission, please authorize
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.