调用CreateFile,在数据开发中创建一个文件。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateFile

要执行的操作。

AutoRerunTimes Integer 3

出错自动重跑的次数,最多10次。

FileDescription String 这里是文件描述

文件的描述信息。

FileFolderPath String 业务流程/第一个业务流程/数据集成/文件夹1/文件夹2

文件的路径。

FileName String 文件名

文件的名称。

FileType Integer 10

文件的代码类型,常用的代码类型包括6(Shell)、10(ODPS SQL)、11(ODPS MR)、23(数据集成)、24(ODPS Script)、99(虚拟节点)、221(PyODPS 2)、225(ODPS Spark)、227(EMR Hive)、228(EMR Spark)、229(EMR Spark SQL)、230(EMR MR)、239(OSS对象检查)、257(EMR Shell)、258(EMR Spark Shell)、259(EMR Presto)、260(EMR Impala)、900(实时同步)、1089(跨租户节点)、1091(Hologres开发)、1093(Hologres SQL)、1100(赋值节点)、1221(PyODPS 3)。

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

文件依赖的上游文件的输出,对应到调度配置>调度依赖>父节点输出名称一列的值,以英文逗号(,)分隔。

ProjectId Long 10000

Dataworks工作空间的ID,您可以单击页面右上角的小扳手图标,进入工作空间管理页面查看。

RegionId String cn-zhangjiakou

服务所在地域的列表。

Owner String 1000000000001

文件责任人的阿里云用户ID。如果该参数为空,则默认使用调用者的阿里云用户ID。

Content String SHOW TABLES;

文件代码内容,不同代码类型(fileType)的文件,代码格式不同。您可以在运维中心找到对应类型的任务,右键单击查看代码,查看具体的代码格式。

AutoRerunIntervalMillis Integer 120000

出错自动重跑间隔,单位为毫秒,最大为1800000毫秒(30分钟)。对应页面上的调度配置>时间属性>出错自动重跑间隔。页面上时间的单位为分钟,请在调用时注意时间的转换。

RerunMode String ALL_ALLOWED

重跑属性,包括ALL_ALLOWED(运行成功或失败后皆可重跑)、FAILURE_ALLOWED(运行成功后不可重跑,运行失败后可以重跑)和ALL_DENIED(运行成功或失败皆不可重跑)。对应页面上的调度配置>时间属性>重跑属性。

Stop Boolean false

是否暂停调度,对应页面上的调度配置>时间属性>暂停调度。

ParaValue String a=x b=y

调度参数,对应页面上的调度配置>基础配置>参数。

StartEffectDate Long 936923400000

自动调度开始生效的毫秒时间戳,对应页面上的调度配置>时间属性>生效时间>开始时间的毫秒时间戳。

EndEffectDate Long 4155787800000

停止自动调度的毫秒时间戳,对应页面上的调度配置>时间属性>生效时间>结束时间的毫秒时间戳。

CronExpress String 00 05 00 * * ?

自动调度的cron表达式,对应页面上的调度配置>时间属性>cron表达式:

  • 每天凌晨5点30分定时调度:00 30 05 * * ?
  • 每个小时的第15分钟定时调度:00 15 * * * ?
  • 每隔十分钟调度一次:00 00/10 * * * ?
  • 每天8点到17点,每个十分钟调度一次:00 00-59/10 8-23 * * * ?
  • 每月的1日0点20分自动调度:00 20 00 1 * ?
  • 从1月1日0点10分开始,每过3个月调度一次:00 10 00 1 1-12/3 ?
  • 每周二、周五的0点5分自动调度:00 05 00 * * 2,5

由于Dataworks调度系统的规则,cron表达式有以下限制:

  • 最短调度间隔时间为5分钟。
  • 每天最早调度时间为0点5分。
CycleType String DAY

调度周期的类型,包括NOT_DAY(分钟、小时)和DAY(日、周、月),对应页面上的调度配置>时间属性>调度周期。

DependentType String NONE

依赖上一周期的方式,包括NONE(取消勾选依赖上一周期)、SELF(本节点)、CHILD(一层子节点)和USER_DEFINE(自定义)。

DependentNodeIdList String abc

依赖上一周期的节点列表。

ProjectIdentifier String dw_project

Dataworks项目的唯一标识符,即数据开发页面顶部切换项目处的英文标识。

该参数与projectId参数二者必须设置其一,以确定本次API调用操作的Dataworks项目。

ResourceGroupIdentifier String group_375827434852437

文件发布成任务后,任务执行时对应的资源组。对应页面上调度配置>资源属性>调度资源组的配置。

您可以通过ListResourceGroups接口获取工作空间可用的资源组列表。ResourceGroupType传1,拿到结果后取出Identifier字段。

ResourceGroupId Long 375827434852437

文件发布成任务后,任务执行时对应的资源组。对应页面上调度配置>资源属性>调度资源组的配置。与ResourceGroupIdentifier二者设置其一即可。

您可以通过ListResourceGroups接口获取工作空间可用的资源组列表。ResourceGroupType传1,拿到结果后取出Id字段。

ConnectionName String odps_first

文件发布成任务后,任务执行时连接的数据源,对应页面顶部的选择数据源下拉列表。

项目可用的数据源列表可以通过ListConnections接口获取,拿到结果后取出字段

您可以通过ListConnections接口获取工作空间可用的数据源列表,拿到结果后取出Name字段。

返回数据

名称 类型 示例值 描述
Data Long 1000001

文件创建成功后的ID。

ErrorCode String Invalid.Tenant.ConnectionNotExists

错误码。

ErrorMessage String The connection does not exist.

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0000-ABCD-EFG

本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。

Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateFile
&AutoRerunTimes=3
&FileDescription=这里是文件描述
&FileFolderPath=业务流程/第一个业务流程/数据集成/文件夹1/文件夹2
&FileName=文件名
&FileType=10
&InputList=project_root,project.file1,project.001_out
&ProjectId=10000
&RegionId=cn-zhangjiakou
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>0000-ABCD-EFG</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>1000001</Data>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<Success>true</Success>

JSON 格式

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

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.Access Access is forbidden. Activate DataWorks first. 您被限制访问,请开通DataWorks企业版或旗舰版。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
403 ResourceNotAuthorized.Api You are not authorized to access the resources. 您无法访问未取得授权的资源。
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. 您的请求过于频繁,请尝试放缓请求速度。

访问错误中心查看更多错误码。