文档

CreateUdfFile - 在数据开发中创建函数类型文件

更新时间:

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*Write
  • 全部资源
    *

请求参数

名称类型必填描述示例值
FileFolderPathstring

函数文件所在的文件夹路径。

业务流程/第一个业务流程/函数/字符串处理
ProjectIdlong

DataWorks 工作空间的 ID,您可以单击页面右上角的小扳手图标,进入工作空间管理页面查看。

10000
FileNamestring

函数的名称。

StringConcat
FunctionTypestring

函数的分类,对应创建函数表单中的函数类型一项,包括 MATH(数学运算函数)、AGGREGATE(聚合函数)、STRING(字符串处理函数)、DATE(日期处理函数)、ANALYTIC(窗口函数)和 OTHER(其他函数)。

STRING
ClassNamestring

函数定义所在的类名,对应创建函数表单的类名一项。

com.alibaba.DataWorks.api.udf.StringConcat
Resourcesstring

函数引用的资源名列表,对应创建表中的资源列表。多个资源名称之间使用英文逗号(,)分隔。

string-concat-1.0.0.jar,commons-lang-2.6.jar
UdfDescriptionstring

函数用途的说明,对应创建函数表单中的描述。

把几个字符串连接起来生成一个新的字符串
CmdDescriptionstring

函数调用的命令格式,对应创建函数表单中的命令格式。

StringConcat(String... substrs)
ParameterDescriptionstring

函数入参的说明,对应创建函数表单中的参数说明。

需要连接的字符串列表
ReturnValuestring

函数的返回值说明,对应创建函数表单中的返回值。

所有字符串按照输入顺序前后连接生成的新字符串
Examplestring

函数调用示例,对应创建函数表单中的示例。

StringConcat('a', 'b', 'c')
ProjectIdentifierstring

DataWorks 工作空间的唯一标识符,即数据开发页面顶部切换工作空间处的英文标识。

dw_project
CreateFolderIfNotExistsboolean

当参数中指定的目录(FileFolderPath)在系统中不存在时,是否自动创建此目录。取值如下:

true:若此目录不存在,自动创建此目录

false:若此目录不存在,调用失败

false

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码。

200
Datalong

文件创建成功后的 ID。

100000002
RequestIdstring

本次调用的唯一 ID。出现错误后,您可以根据该 ID 排查问题。

0000-ABCD-EFG****
ErrorMessagestring

错误信息。

The connection does not exist.
Successboolean

调用是否成功。

true
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙,请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁,请尝试放缓请求速度。
500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误,请稍后再试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:429
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:CreateFolderIfNotExists
  • 本页导读 (1)