接口说明
调试或调用该接口时，填写的参数必须与该节点原本的文件配置不同。例如，源节点的某参数值为 A，则需要变更为 B 后再提交。如果仍填写 A，会报 invalid 异常。
流控信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
FileFolderPathstring | 文件所在的路径。 示例值:Business_process/First_Business_Process/data_integration/Folder_1/Folder_2参考取值来源: CreateFile |
ProjectIdinteger<int64> | DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间管理页面获取 ID。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:100001参考取值来源: ListProjectIds CreateProject AddProjectMemberToRole |
FileNamestring | 文件的名称。您可以通过重新设置 FileName 的值来修改文件名称。展开详情 示例值:ods_user_info_d参考取值来源: GetFile CreateFile ListFiles |
FileDescriptionstring | 文件的描述。 示例值:Here is the file description |
Contentstring | 文件代码内容，不同代码类型（fileType）的文件，代码格式不同。您可以在运维中心，右键单击对应类型的任务，选择查看代码，查看具体的代码格式。 示例值:SELECT "1"; |
AutoRerunTimesinteger<int32> | 文件出错后，自动重跑的次数。 示例值:3 |
AutoRerunIntervalMillisinteger<int32> | 出错自动重跑时间间隔，单位为毫秒。最大为 1800000 毫秒（30 分钟）。展开详情 示例值:120000 |
RerunModestring | 重跑属性。取值如下：展开详情 示例值:ALL_ALLOWED枚举值:ALL_ALLOWDFAILURE_ALLOWEDALL_DENIEDALL_ALLOWED |
Stopboolean | 是否暂停调度，取值如下：展开详情 示例值:false |
ParaValuestring | 调度参数。展开详情 示例值:x=a y=b z=c |
StartEffectDateinteger<int64> | 开始自动调度的毫秒时间戳。展开详情 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:936923400000取值 >= 0 |
EndEffectDateinteger<int64> | 停止自动调度的时间戳，单位为毫秒。展开详情 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:4155787800000取值 >= 0 |
CronExpressstring | 周期调度的 cron 表达式，该参数与 DataWorks 控制台中，数据开发任务的“调度配置>时间属性>cron 表达式”对应。配置完“调度周期”及“定时调度时间”后，DataWorks 会自动生成相应 cron 表达式。展开详情 示例值:00 00-59/5 1-23 * * ? |
CycleTypestring | 调度周期的类型，包括 NOT_DAY（分钟、小时）和 DAY（日、周、月）。展开详情 示例值:NOT_DAY枚举值:DAYNOT_DAY |
DependentTypestring | 依赖上一周期的方式。取值如下：展开详情 示例值:USER_DEFINE枚举值:NONEUSER_DEFINECHILDSELFUSER_DEFINE_AND_SELFCHILD_AND_SELF |
DependentNodeIdListstring | 当 DependentType 参数配置为 USER_DEFINE 时，用于设置当前文件具体依赖的节点 ID。依赖多个节点时，使用英文逗号（,）分隔。展开详情 示例值:5,10,15,20 |
InputListstring | 文件依赖的上游文件的输出名称。依赖多个输出时，使用英文逗号（,）分隔。展开详情 示例值:project_root,project.file1,project.001_out |
ProjectIdentifierstring | DataWorks 工作空间的名称。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间名称。展开详情 示例值:dw_project参考取值来源: CreateProject GetProject ListProjects |
FileIdinteger<int64> | 文件的 ID。您可以调用 ListFiles 接口获取文件 ID。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:100000001参考取值来源: GetFile ListFiles DeployFile SubmitFile |
OutputListstring | 文件的输出。展开详情 示例值:dw_project.ods_user_info_d |
ResourceGroupIdentifierstring | 文件发布成任务后，任务执行时对应的资源组。您可以调用 ListResourceGroups 获取工作空间可用的资源组列表。 示例值:default_group |
ConnectionNamestring | 文件对应任务执行时，任务使用的数据源标识符。您可以调用 ListDataSources 获取可用的数据源列表。 示例值:odps_source |
Ownerstring | 文件所有者的用户 ID。 示例值:18023848927592 |
AutoParsingboolean | 文件是否开启自动解析功能。取值如下：展开详情 示例值:true |
SchedulerTypestring | 调度的类型，取值如下：展开详情 示例值:NORMAL枚举值:NORMALSKIPPAUSEMANUAL |
AdvancedSettingsstring | 任务的高级配置。展开详情 示例值:{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"} |
StartImmediatelyboolean | 发布后是否立即启动。取值如下：展开详情 示例值:true |
InputParametersstring | |
OutputParametersstring | |
IgnoreParentSkipRunningPropertyboolean | 调度配置->上一周期->是否跳过上游的空跑属性。 示例值:true |
ApplyScheduleImmediatelyboolean | 是否发布后立即生效调度配置。 示例值:true |
Timeoutinteger<int32> | 调度配置超时定义。 示例值:1 |
ImageIdstring | 自定义镜像 ID 示例值:m-uf6d7npxk1hhek8ng0cb |
返回参数
| 字段名称 | 字段详情 |
|---|---|
HttpStatusCodeinteger<int32> | HTTP 状态码。 示例值:200 |
ErrorMessagestring | 错误信息。 示例值:The connection does not exist. |
RequestIdstring | 本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。 示例值:0000-ABCD-EFGH-IJKLMNOPQ |
ErrorCodestring | 错误码。 示例值:Invalid.Tenant.ConnectionNotExists |
Successboolean | 调用是否成功。取值如下：展开详情 示例值:true |