Updates a file.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
AutoRerunTimes Integer Yes 3

The number of automatic rerunning errors.

FileDescription String Required Here is the file description

Description of the file.

FileFolderPath String Required Workflow /first workflow /data integration /Folder 1 /Folder 2

The path of the file.

FileId Long Yes 100000001

The ID of the file.

FileName String Required ods_user_info_d

The name of the file.

InputList String Required project_root,project.file1,project.001_out

The output of the file. Separate them with commas (,).

ProjectId Long Yes 10000

Dataworks workspace ID and click the workspace manage icon in the upper-right corner to view the workspace information.

RegionId String Required cn-zhangjiakou

The list of regions where the services are located.

Content String No SELECT "1";

The code content of the file. The code formats vary with the file type. You can go to the scheduling center, right-click a task, and then select View code to view the code format.

AutoRerunIntervalMillis Integer No 120000

The automatic rerunning interval of the error. Unit: milliseconds. On the Select Properties page, choose schedule configuration> time properties. Then, click the error Details tab and select the automatically rerun interval. The unit of time on the page is minutes, please pay attention to the conversion time when calling.

RerunMode String No ALL_ALLOWED

The rerun attributes, including ALL_ALLOWED (which can be rerun after a successful or failed run), FAILURE_ALLOWED (which cannot be rerun after a successful run, and can be rerun after a failed run), and ALL_DENIED (which cannot be rerun after a successful or failed run). On the Select Properties page, choose Properties> dashboard.

Stop Boolean No false

Specifies whether to disable scheduling. For example, choose scheduling configuration> scheduling> disable scheduling in the scheduling section.

ParaValue String No x=a y=b z=c

Scheduling parameter, according to scheduling configuration> basic configuration> parameters on the page.

StartEffectDate Long No 936923400000

The millisecond timestamp when the automatic scheduling starts to take effect, corresponding to the millisecond timestamp of the schedule configuration> time attribute> Effective Time> start time on the page.

EndEffectDate Long No 4155787800000

The millisecond timestamp that indicates when auto scheduling is stopped. The timestamp corresponds to the timestamp when scheduling configuration> time attribute> Effective Time> end time on the properties page.

CronExpress String No 00 00-59/5 1-23 * * ?

The cron expression used for automatic scheduling. You can select schedule configuration> Properties> cron expression.

  • Scheduled scheduling every day at 05:30: 00 30 05 **? .
  • Scheduled scheduling for the 15th minute of each hour: 00 15 ***? .
  • Scheduling every 10 minutes: 00 00/10 ***? .
  • From 8 o'clock to 17 o'clock every day, it is scheduled every 10 minutes: 00-59/10-23 ***? .
  • Automatic scheduling at 00:20 on the 1th of each month: 00 20 00 1 *? .
  • From 1: 00:10 on January 1, once every 3 months: 00 10 00 1-12/3? .
  • Automatic scheduling every Tuesday and Friday at 00:05: 000500[2,2,5.

Dataworks scheduling system rules, cron expressions have the following restrictions:

  • The shortest scheduling gap is 5 minutes.
  • The earliest scheduling time is 00:05 every day.
CycleType String No NOT_DAY

The scheduling cycle type, including NOT_DAY (minute, hour) and DAY (DAY, week, month), according to the scheduling configuration> time Property> scheduling cycle on the page.

DependentType String No USER_DEFINE

Select a cross-cycle dependency, including NONE (deselect cross-cycle dependency), SELF, CHILD, and USER_DEFINE (custom).

DependentNodeIdList String No 5,10,15,20

When the value of the DependentType parameter is USER_DEFINE, you can specify task IDs and separate them with commas (,). On the page, choose Properties> depend on previous cycle> custom in the schedule section.

ProjectIdentifier String No dw_project

Dataworks unique identifier of the workspace, that is, the name of the workspace at the top of the data Development page.

You must specify either this parameter or the ProjectId parameter to determine the Dataworks workspace for the current API call.

OutputList String No dw_project.ods_user_info_d

The output of the configuration file. Separate multiple output values with commas (,). These values correspond to the values in the following column: scheduling configuration> dependencies> current node output name.

ResourceGroupIdentifier String No default_group

File ID specifies the resource group that hosts the task. You can call the ListResourceGroupsRequest to obtain the resourceGroupType resource group ID.

ConnectionName String No odps_first

File corresponds to the identifier of the data source from which the task can be executed. For the corresponding identifier, call ListConnectionsRequest to obtain a list of available data sources.

Owner String No 18023848927592

User ID of the file owner

Response parameters

Parameter Type Example Description
ErrorCode String 0

The error code.

ErrorMessage String Success

The returned message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0000-ABCD-EFG****

The unique ID of the call. You can use the error ID to troubleshoot the error.

Success Boolean true

Indicates whether the call is successful.

Examples

Sample requests

http(s)://[Endpoint]/? Action=UpdateFile
&AutoRerunTimes=3
&FileDescription=file description
&FileFolderPath= workflow /first workflow /data integration /Folder 1 /Folder 2
&FileId=100000001
&FileName=ods_user_info_d
&InputList=project_root,project.file1,project.001_out
&ProjectId=10000
&RegionId=cn-zhangjiakou
&<Common request parameters>

Sample success responses

JSON format

{"RequestId":"0000-ABCD-EFGH-IJKLMNOPQ","HttpStatusCode":"200","ErrorCode":"0","ErrorMessage":"Success","Success":"true"}

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, possibly because you have not activated DataWorks.
500 InternalError.System An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. You cannot access resources without authorization.
429 Throttling.Api The request for this resource has exceeded your available limit. The request for the resource exceeds your available upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks the system is busy, please try again later.
429 Throttling.User Your request is too frequent. Try again later. Your request is too frequent, please try to slow down the request speed.

For a list of error codes, visit the API Error Center.