CreateUdfFile - DataWorks - Alibaba Cloud Documentation Center

Creates a file for a function in DataStudio.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
FileFolderPath	string	Yes	The path of the folder in which the file for the function is stored.
ProjectId	long	No	The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.	10000
FileName	string	Yes	The name of the file for the function.	StringConcat
FunctionType	string	Yes	The type of the function. Valid values: MATH, AGGREGATE, STRING, DATE, ANALYTIC, and OTHER. This parameter corresponds to the Function Type parameter in the Register Function section of the configuration tab of the function on the DataStudio page.	STRING
ClassName	string	Yes	The name of the class in which the function is defined. This parameter corresponds to the Class Name parameter in the Register Function section of the configuration tab of the function in the DataWorks console.	com.alibaba.DataWorks.api.udf.StringConcat
Resources	string	Yes	The names of the resources that are referenced by the function. This parameter corresponds to the Resources parameter in the Register Function section of the configuration tab of the function in the DataWorks console. Multiple resource names are separated by commas (,).	string-concat-1.0.0.jar,commons-lang-2.6.jar
UdfDescription	string	Yes	The description of the function. This parameter corresponds to the Description parameter in the Register Function section of the configuration tab of the function in the DataWorks console.
CmdDescription	string	No	The syntax used for calling the function. This parameter corresponds to the Expression Syntax parameter in the Register Function section of the configuration tab of the function in the DataWorks console.	StringConcat(String... substrs)
ParameterDescription	string	No	The description of the input parameters of the function. This parameter corresponds to the Parameter Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.
ReturnValue	string	No	The description of the return value of the function. This parameter corresponds to the Return Value parameter in the Register Function section of the configuration tab of the function on the DataStudio page.
Example	string	No	The example for calling the function. This parameter corresponds to the Example parameter in the Register Function section of the configuration tab of the function in the DataWorks console.	StringConcat('a', 'b', 'c')
ProjectIdentifier	string	No	The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace. You must specify either this parameter or the projectId parameter to determine the DataWorks workspace to which the operation is called.	dw_project

Response parameters

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code returned.	200
Data	long	The ID of the file that was created.	100000002
RequestId	string	The ID of the request. You can troubleshoot issues based on the ID.	0000-ABCD-EFG****
ErrorMessage	string	The error message returned.	The connection does not exist.
Success	boolean	Indicates whether the request is successful.	true
ErrorCode	string	The error code returned.	Invalid.Tenant.ConnectionNotExists

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "Data": 100000002,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}

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
2023-07-14	The Error code has changed. The request parameters of the API has changed	View Change Details