CreateResourceFile-DataWorks(DataWorks)-阿里云帮助中心

Creates or uploads a resource file in Data Studio. The feature that is implemented by calling this operation is the same as the resource creation feature provided in the integrated development environment (IDE).

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the workspace configuration page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the operation is applied.	10111
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.	File name
FileType	integer	Yes	The type of the code for the file. The code for files varies based on the file type. For more information, see DataWorks nodes. You can call the ListFileType operation to query the type of the code for the file.	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 caller's Alibaba cloud user ID is used by default.	1000000000001
Content	string	No	The code for the file. The code format varies based on the file type. To view the code format for a specific file type, go to Operation Center, right-click a node of the file type, and then select View Code.	SHOW TABLES;
ResourceFile	string	No	The OSS URL for uploading files 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	File resource Upload mode. Currently, only files of the File type of MaxCompute are valid. The values are as follows: true: The Resource mode that can be downloaded. false: The text mode for online editing.	false
RegisterToCalcEngine	boolean	Yes	Whether to synchronously Upload resources to the computing engine.	false
StorageURL	string	No	The storage path of the resource file on the computing engine. Currently, only EMR and CDH use this field. EMR format is [oss\|hdfs]://path/to/object. CDH must be/user/admin/lib by default.	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 it is created.	1000001
RequestId	string	The ID of the request. You can use the ID to locate logs and troubleshoot issues.	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.