调用UpdateFile更新已有的文件节点。
调试或调用该接口时,填写的参数必须和该节点原本的文件配置不同。例如,源节点的某参数值为A,则需要变更为B后再提交。如果仍填写A,会报invalid异常。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateFile |
要执行的操作。 |
AutoRerunTimes | Integer | 是 | 3 |
出错自动重跑的次数。 |
FileDescription | String | 是 | 这里是文件描述 |
文件的描述。 |
FileFolderPath | String | 是 | 业务流程/第一个业务流程/数据集成/文件夹1/文件夹2 |
文件的路径。 |
FileId | Long | 是 | 100000001 |
文件的ID。 |
FileName | String | 是 | ods_user_info_d |
文件的名称。您可以通过重新设置FileName的值来修改文件名称。 例如,使用ListFiles接口查询目标目录下的文件ID,通过UpdateFile接口,输入查询的文件ID至FileId参数,并配置FileName的参数值,即可修改相应文件的名称。 |
InputList | String | 是 | project_root,project.file1,project.001_out |
文件依赖的上游文件的输出,对应调度配置>调度依赖>父节点输出名称一列的值。使用英文逗号(,)分隔。 |
ProjectId | Long | 是 | 10000 |
Dataworks工作空间的ID,您可以单击页面右上角的小扳手图标,进入工作空间管理页面查看。 |
RegionId | String | 是 | cn-zhangjiakou |
服务所在地域的列表。 |
Content | String | 否 | SELECT "1"; |
文件代码内容,不同代码类型(fileType)的文件,代码格式不同。您可以在运维中心,右键单击对应类型的任务,选择查看代码,查看具体的代码格式。 |
AutoRerunIntervalMillis | Integer | 否 | 120000 |
出错自动重跑间隔,单位为毫秒。对应页面上的调度配置>时间属性>出错自动重跑间隔。页面上的时间单位为分钟,请在调用时注意转换时间。 |
RerunMode | String | 否 | ALL_ALLOWED |
重跑属性,包括ALL_ALLOWED(运行成功或失败后皆可重跑)、FAILURE_ALLOWED(运行成功后不可重跑,运行失败后可以重跑)和ALL_DENIED(运行成功或失败皆不可重跑)。对应页面上的调度配置>时间属性>重跑属性。 |
Stop | Boolean | 否 | false |
是否暂停调度,对应页面上的调度配置>时间属性>暂停调度。 |
ParaValue | String | 否 | x=a y=b z=c |
调度参数,对应页面上的调度配置>基础配置>参数。 |
StartEffectDate | Long | 否 | 936923400000 |
自动调度开始生效的毫秒时间戳,对应页面上的调度配置>时间属性>生效时间>开始时间的毫秒时间戳。 |
EndEffectDate | Long | 否 | 4155787800000 |
停止自动调度的毫秒时间戳,对应页面上的调度配置>时间属性>生效时间>结束时间的毫秒时间戳。 |
CronExpress | String | 否 | 00 00-59/5 1-23 * * ? |
自动调度的cron表达式,对应页面上的调度配置>时间属性>cron表达式:
由于Dataworks调度系统的规则,cron表达式有以下限制:
|
CycleType | String | 否 | NOT_DAY |
调度周期的类型,包括NOT_DAY(分钟、小时)和DAY(日、周、月),对应页面上的调度配置>时间属性>调度周期。 |
DependentType | String | 否 | USER_DEFINE |
依赖上一周期的方式,包括NONE(取消勾选依赖上一周期)、SELF(本节点)、CHILD(一层子节点)和USER_DEFINE(自定义)。 |
DependentNodeIdList | String | 否 | 5,10,15,20 |
当DependentType为USER_DEFINE时,设置具体依赖的调度任务ID列表,使用英文逗号(,)分隔。对应页面上的调度配置>时间属性>依赖上一周期>自定义后,出现的输入框。 |
ProjectIdentifier | String | 否 | dw_project |
Dataworks工作空间的唯一标识符,即数据开发页面顶部切换工作空间处的英文标识。 该参数与ProjectId参数二者必须设置其一,以确定本次API调用操作的Dataworks工作空间。 |
OutputList | String | 否 | dw_project.ods_user_info_d |
文件的输出,对应页面中的调度配置>调度依赖>本节点输出名称一列的值,使用英文逗号(,)分隔。 |
ResourceGroupIdentifier | String | 否 | default_group |
文件对应任务应该执行的所在的资源组标识符,对应的标识符请调用 ListResourceGroups,resourceGroupType传1获取可用的资源组列表 |
ConnectionName | String | 否 | odps_first |
文件对应任务应该执行的所在的数据源标识符,对应的标识符请调用 ListConnections获取可用的数据源列表 |
Owner | String | 否 | 18023848927592 |
文件所有者的用户ID |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrorCode | String | Invalid.Tenant.ConnectionNotExists |
错误码。 |
ErrorMessage | String | The connection does not exist. |
错误信息。 |
HttpStatusCode | Integer | 200 |
HTTP状态码。 |
RequestId | String | 0000-ABCD-EFGH-IJKLMNOPQ |
本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。 |
Success | Boolean | true |
调用是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=UpdateFile
&AutoRerunTimes=3
&FileDescription=这里是文件描述
&FileFolderPath=业务流程/第一个业务流程/数据集成/文件夹1/文件夹2
&FileId=100000001
&FileName=ods_user_info_d
&InputList=project_root,project.file1,project.001_out
&ProjectId=10000
&RegionId=cn-zhangjiakou
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>0000-ABCD-EFGH-IJKLMNOPQ</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Success>true</Success>
JSON
格式
{
"RequestId": "0000-ABCD-EFGH-IJKLMNOPQ",
"HttpStatusCode": 200,
"Success": true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | 对该资源的请求已超过您的可用上限。 |
429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks系统繁忙,请稍后再试。 |
429 | Throttling.User | Your request is too frequent. Try again later. | 您的请求过于频繁,请尝试放缓请求速度。 |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 您被限制访问,请开通DataWorks企业版或旗舰版。 |
访问错误中心查看更多错误码。