流控信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
FileFolderPathstring | 文件的路径。 示例值:Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2参考取值来源: CreateUdfFile |
ProjectIdinteger<int64> | DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间 ID。展开详情 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:10000参考取值来源: ListProjectIds CreateProject AddProjectMemberToRole |
FileNamestring | 文件的名称。 示例值:File name参考取值来源: GetFile CreateUdfFile ListFiles |
FileDescriptionstring | 文件的描述信息。 示例值:这里是文件描述字符长度 <= 200 |
FileTypeinteger<int32> | 文件的代码类型。展开详情 示例值:10 |
Ownerstring | 文件责任人的阿里云用户 ID。如果该参数为空，则默认使用调用者的阿里云用户 ID。 示例值:1000000000001 |
Contentstring | 文件代码内容，不同代码类型（fileType）的文件，代码格式不同。您可以在运维中心找到对应类型的任务，右键单击查看代码，查看具体的代码格式。 示例值:SHOW TABLES; |
AutoRerunTimesinteger<int32> | 出错自动重跑的次数，取值最大为 10。 示例值:3 |
AutoRerunIntervalMillisinteger<int32> | 出错自动重跑时间间隔，单位为毫秒。最大为 1800000 毫秒（30 分钟）。展开详情 示例值:120000 |
RerunModestring | 重跑属性。取值如下：展开详情 示例值:ALL_ALLOWED枚举值:ALL_ALLOWEDFAILURE_ALLOWEDALL_DENIED |
Stopboolean | 是否暂停调度，取值如下：展开详情 示例值:false |
ParaValuestring | 调度参数。多个参数之间用空格进行分割。 展开详情 示例值:a=x b=y |
StartEffectDateinteger<int64> | 开始自动调度的毫秒时间戳。展开详情 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:1671608450000取值 >= 0 |
EndEffectDateinteger<int64> | 停止自动调度的时间戳，单位为毫秒。展开详情 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:1671694850000取值 >= 0 |
CronExpressstring | 周期调度的 cron 表达式，该参数与 DataWorks 控制台中，数据开发任务的“调度配置>时间属性>cron 表达式”对应。配置完“调度周期”及“定时调度时间”后，DataWorks 会自动生成相应 cron 表达式。展开详情 示例值:00 05 00 * * ? |
CycleTypestring | 调度周期的类型，包括 NOT_DAY（分钟、小时）和 DAY（日、周、月）。展开详情 示例值:DAY枚举值:DAYNOT_DAY |
DependentTypestring | 依赖上一周期的方式。取值如下：展开详情 示例值:NONE枚举值:NONEUSER_DEFINECHILDSELFUSER_DEFINE_AND_SELFCHILD_AND_SELF |
DependentNodeIdListstring | 依赖上一周期的节点列表。 示例值:abc |
InputListstring | 文件依赖的上游文件的输出名称，多个输出使用英文逗号（,）分隔。展开详情 示例值:project_root,project.file1,project.001_out |
ProjectIdentifierstring | DataWorks 工作空间的名称。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间名称。展开详情 示例值:dw_project参考取值来源: CreateProject GetProject ListProjects |
ResourceGroupIdentifierstring | 文件发布成任务后，任务执行时对应的资源组。您可以调用 ListResourceGroups 通过 identifier 字段获取工作空间可用的资源组列表。展开详情 示例值:group_375827434852437 |
ResourceGroupIdinteger<int64> | 该字段已废弃，请勿使用。展开详情 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:375827434852437参考取值来源: ListResourceGroups |
ConnectionNamestring | 文件发布成任务后，任务执行时连接的数据源。展开详情 示例值:odps_source |
AutoParsingboolean | 文件是否开启自动解析功能。取值如下：展开详情 示例值:true |
SchedulerTypestring | 调度的类型，取值如下：展开详情 示例值:NORMAL枚举值:NORMALMANUALPAUSESKIP |
AdvancedSettingsstring | 任务的高级配置。展开详情 示例值:{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"} |
StartImmediatelyboolean | 发布后是否立即启动。展开详情 示例值:true |
InputParametersstring | |
OutputParametersstring | |
IgnoreParentSkipRunningPropertyboolean | 是否沿用上一周期空跑属性。取值如下：展开详情 示例值:false |
CreateFolderIfNotExistsboolean | 当参数中指定的目录（FileFolderPath）在系统中不存在时，是否自动创建此目录。取值如下：展开详情 示例值:false |
ApplyScheduleImmediatelyboolean | 是否发布后立即生效调度配置 示例值:true |
Timeoutinteger<int32> | 调度配置超时定义 示例值:1 |
ImageIdstring | 自定义镜像 ID 示例值:m-bp1h4b5a8ogkbll2f3tr |
返回参数
| 字段名称 | 字段详情 |
|---|---|
HttpStatusCodeinteger<int32> | HTTP 状态码。 示例值:200 |
Datainteger<int64> | 文件创建成功后的 ID。 注意
请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。 示例值:1000001 |
RequestIdstring | 本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。 示例值:0000-ABCD-EFG |
ErrorMessagestring | 错误信息。 示例值:The connection does not exist. |
Successboolean | 调用是否成功。取值如下：展开详情 示例值:true |
ErrorCodestring | 错误码。 示例值:Invalid.Tenant.ConnectionNotExists |