CreateResourceFile

更新时间:
复制 MD 格式

Supports users in specifying their own files (such as JAR, PY, archive, or file) to create Data Development resource files.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

ProjectId

integer

Yes

The ID of the DataWorks workspace. You can log on to the DataWorks console, go to the workspace configuration page, and obtain the workspace ID. This parameter is required to identify the DataWorks workspace for this API call.

10000

FileFolderPath

string

Yes

The path of the file.

Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2

FileName

string

Yes

The name of the file.

Filename

FileType

integer

Yes

The code type of the file.

Different file types correspond to different code types. For more information, see DataWorks Node Types.
You can also invoke the ListFileType API to query the code types of files.

10

FileDescription

string

No

The description of the file.

This is a description

Owner

string

No

The Alibaba Cloud User ID of the file owner. If this parameter is empty, the Alibaba Cloud User ID of the caller is used by default.

1000000000001

Content

string

No

The code content of the file. The code format varies depending on the code type (fileType). You can locate a job of the corresponding type in the Operation Center, right-click it, and select View Code to check the specific code format.

SHOW TABLES;

ResourceFile

string

No

The OSS URL for file upload provided by POP.

http://bucketname1.oss-cn-shanghai.aliyuncs.com/example

OriginResourceName

string

Yes

The name of the original resource file.

origin_file_name.sql

UploadMode

boolean

No

The upload mode for the resource file. This parameter currently applies only to File-type files in MaxCompute. Valid values:

  • true: Downloadable resource mode.

  • false: Online-editable text mode.

false

RegisterToCalcEngine

boolean

Yes

Indicates whether to synchronize and upload the resource to the compute engine.

false

StorageURL

string

No

The Storage Path of the resource file on the compute engine. This field is currently used only by EMR and CDH. The EMR format is [osshdfs]://path/to/object, and for CDH, the default value must be /user/admin/lib.

oss://oss-cn-shanghai.aliyuncs.com/emr-test

Response elements

Element

Type

Description

Example

object

Schema of Response

Data

integer

The ID of the file after successful creation.

1000001

RequestId

string

The unique ID of this request. If an error occurs, you can use this ID to troubleshoot the issue.

0000-ABCD-EFG

Examples

Success response

JSON format

{
  "Data": 1000001,
  "RequestId": "0000-ABCD-EFG"
}

Error codes

HTTP status code

Error code

Error message

Description

500 InternalError.System An internal system error occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. No permission, please authorize
429 Throttling.Api The request for this resource has exceeded your available limit.
429 Throttling.System The DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.