Creates or uploads a resource file in DataStudio. The feature that is implemented by calling this operation is the same as the resource creation feature provided in the integrated development environment (IDE).
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dataworks:* | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectId | long | Yes | The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the operation is applied. | 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. | 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:
| 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 parameters
Examples
Sample success responses
JSONformat
{
"Data": 1000001,
"RequestId": "0000-ABCD-EFG"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 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. | - |
| 500 | InternalError.System | An internal system error occurred. Try again later. | - |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|