调用CreateResourceFile,在数据开发中创建或上传一个资源文件,此API功能与IDE界面中新建资源功能保持一致。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateResourceFile |
要执行的操作。 |
ProjectId | Long | 是 | 10000 | DataWorks工作空间的ID。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间ID。需要用该参数来确定本次API调用操作的DataWorks工作空间。 |
FileFolderPath | String | 是 | 业务流程/第一个业务流程/MaxCompute/文件夹1/文件夹2 | 文件的路径。 |
FileName | String | 是 | 文件名 | 文件的名称。 |
FileType | Integer | 是 | 10 | 文件的代码类型。 常用的代码及其对应的文件类型包括6(Shell)、10(ODPS SQL)、11(ODPS MR)、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)。 您可以调用ListFileType接口,查询文件的代码类型。 |
FileDescription | String | 否 | 这是一个描述信息 | 文件的描述信息。 |
Owner | String | 否 | 1000000000001 | 文件责任人的阿里云用户ID。如果该参数为空,则默认使用调用者的阿里云用户ID。 |
Content | String | 否 | SHOW TABLES; | 文件代码内容,不同代码类型(fileType)的文件,代码格式不同。您可以在运维中心找到对应类型的任务,右键单击查看代码,查看具体的代码格式。 |
ResourceFile | String | 否 | http://bucketname1.oss-cn-shanghai.aliyuncs.com/example | POP提供的文件上传OSS URL |
OriginResourceName | String | 是 | origin_file_name.sql | 原始资源文件的名称 |
UploadMode | Boolean | 否 | false | 文件资源上传模式。目前仅对MaxCompute的File类型文件生效,取值如下:
|
RegisterToCalcEngine | Boolean | 是 | false | 是否将资源同步上传到计算引擎 |
StorageURL | String | 否 | oss://oss-cn-shanghai.aliyuncs.com/emr-test | 资源文件在计算引擎上的存储路径,目前只有EMR和CDH用到该字段。EMR格式为oss|hdfs://path/to/object,CDH默认需要填写为/user/admin/lib。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Long | 1000001 | 文件创建成功后的ID。 |
RequestId | String | 0000-ABCD-EFG | 本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateResourceFile
&ProjectId=10000
&FileFolderPath=业务流程/第一个业务流程/MaxCompute/文件夹1/文件夹2
&FileName=文件名
&FileType=10
&FileDesc=这里是文件描述
&Owner=1000000000001
&Content=SHOW TABLES;
&OriginResourceName=origin_file_name.sql
&UploadMode=false
&RegisterToCalcEngine=false
&StorageUri=oss://oss-cn-chengdu-internal.aliyuncs.com/chengdu-bucketname/
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateResourceFileResponse>
<Data>1000001</Data>
<RequestId>0000-ABCD-EFG</RequestId>
</CreateResourceFileResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Data" : 1000001,
"RequestId" : "0000-ABCD-EFG"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 您的请求过于频繁,请尝试放缓请求速度。 |
500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
访问错误中心查看更多错误码。