CreateUdfFile_大数据开发治理平台 DataWorks_API文档

2020-05-18

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作
暂无数据

请求参数

字段名称	字段详情
FileFolderPathstring	函数文件所在的文件夹路径。示例值:Business_process/First_Business_Process/function/string_processing参考取值来源: CreateFile
ProjectIdinteger<int64>	DataWorks 工作空间的 ID，您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:10000参考取值来源: ListProjectIds CreateProject AddProjectMemberToRole
FileNamestring	函数的名称。示例值:StringConcat参考取值来源: CreateFile GetFile ListFiles
FunctionTypestring	函数的分类，对应创建函数表单中的函数类型一项，包括 MATH（数学运算函数）、AGGREGATE（聚合函数）、STRING（字符串处理函数）、DATE（日期处理函数）、ANALYTIC（窗口函数）和 OTHER（其他函数）。示例值:STRING枚举值:MATHAGGREGATESTRINGDATEANALYTICOTHER
ClassNamestring	函数定义所在的类名，对应创建函数表单的类名一项。示例值:com.alibaba.DataWorks.api.udf.StringConcat
Resourcesstring	函数引用的资源名列表，对应创建表中的资源列表。多个资源名称之间使用英文逗号（,）分隔。示例值:string-concat-1.0.0.jar,commons-lang-2.6.jar
UdfDescriptionstring	函数用途的说明，对应创建函数表单中的描述。示例值:Concatenate several strings to generate a new string
CmdDescriptionstring	函数调用的命令格式，对应创建函数表单中的命令格式。示例值:StringConcat(String... substrs)
ParameterDescriptionstring	函数入参的说明，对应创建函数表单中的参数说明。示例值:List of strings to be connected
ReturnValuestring	函数的返回值说明，对应创建函数表单中的返回值。示例值:New strings generated by concatenating all strings before and after the input order
Examplestring	函数调用示例，对应创建函数表单中的示例。示例值:StringConcat('a', 'b', 'c')
ProjectIdentifierstring	DataWorks 工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。示例值:dw_project参考取值来源: CreateProject GetProject ListProjects
CreateFolderIfNotExistsboolean	当参数中指定的目录（FileFolderPath）在系统中不存在时，是否自动创建此目录。取值如下：展开详情示例值:false

返回参数

字段名称	字段详情
HttpStatusCodeinteger<int32>	HTTP 状态码。示例值:200
Datainteger<int64>	文件创建成功后的 ID。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:100000002
RequestIdstring	本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。示例值:0000-ABCD-EFG****
ErrorMessagestring	错误信息。示例值:The connection does not exist.
Successboolean	调用是否成功。示例值:true
ErrorCodestring	错误码。示例值:Invalid.Tenant.ConnectionNotExists

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

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.	诊断
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.	诊断

变更历史

	变更时间	变更内容概要	操作
	2023-07-14	新增请求参数CreateFolderIfNotExists

相关示例

调用CreateUdfFile，在数据开发中创建函数类型文件。

2021-09-14