文档

UpdateUdfFile - 更新函数的文件信息

更新时间:

调用UpdateUdfFile更新函数的文件信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

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

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

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

10000
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 工作空间的唯一标识符,即数据开发页面顶部切换工作空间处的英文标识。

该参数与 ProjectId 参数二者必须设置其一,以确定本次 API 调用操作的 DataWorks 工作空间。

dw_project
FileIdstring

文件的 ID。

10000001

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码。

200
ErrorMessagestring

错误信息。

The connection does not exist.
RequestIdstring

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

0000-ABCD-EFG****
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Successboolean

调用是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

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.系统内部错误,请稍后再试。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)