调用CreateResourceFile接口,在数据开发中创建或上传一个资源文件,此API功能与IDE界面中新建资源功能保持一致。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dataworks:* | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectId | long | 是 | DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间 ID。需要用该参数来确定本次 API 调用操作的 DataWorks 工作空间。 | 10000 |
FileFolderPath | string | 是 | 文件的路径。 | 业务流程/第一个业务流程/MaxCompute/文件夹1/文件夹2 |
FileName | string | 是 | 文件的名称。 | 文件名 |
FileType | integer | 是 | 文件的代码类型。 不同文件类型其代码不同,详情请参见 DataWorks 节点合集。 您也可以调用 ListFileType 接口,查询文件的代码类型。 | 10 |
FileDescription | string | 否 | 文件的描述信息。 | 这是一个描述信息 |
Owner | string | 否 | 文件责任人的阿里云用户 ID。如果该参数为空,则默认使用调用者的阿里云用户 ID。 | 1000000000001 |
Content | string | 否 | 文件代码内容,不同代码类型(fileType)的文件,代码格式不同。您可以在运维中心找到对应类型的任务,右键单击查看代码,查看具体的代码格式。 | SHOW TABLES; |
ResourceFile | string | 否 | POP 提供的文件上传 OSS URL。 | http://bucketname1.oss-cn-shanghai.aliyuncs.com/example |
OriginResourceName | string | 是 | 原始资源文件的名称。 | origin_file_name.sql |
UploadMode | boolean | 否 | 文件资源上传模式。目前仅对 MaxCompute 的 File 类型文件生效,取值如下:
| false |
RegisterToCalcEngine | boolean | 是 | 是否将资源同步上传到计算引擎。 | false |
StorageURL | string | 否 | 资源文件在计算引擎上的存储路径,目前只有 EMR 和 CDH 用到该字段。EMR 格式为[oss|hdfs]://path/to/object,CDH 默认需要填写为/user/admin/lib。 | oss://oss-cn-shanghai.aliyuncs.com/emr-test |
返回参数
示例
正常返回示例
JSON
格式
{
"Data": 1000001,
"RequestId": "0000-ABCD-EFG"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 没有权限,请授权 |
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. | 系统内部错误,请稍后再试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|