RegisterUdfFunction - 注册自定义函数

通过本API可以选择已创建的自定义函数文件中解析出的自定义函数,选择其中的部分或全部函数进行注册,注册后可在SQL中使用。

调试

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

授权信息

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

请求语法

POST /api/v2/namespaces/{namespace}/udfartifacts/function:registerUdfFunction

请求参数

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

工作空间 ID。

a14bd5d90a****
namespacestring

项目空间名称。

default-namespace
functionNamestring

函数名称,一般与类名称相同,您可以先选择自定义其他名称。

orderRank
udfArtifactNamestring

自定义函数对应的 Jar 或者 Python 文件的名称。

test-udf
classNamestring

自定义函数对应的类名。

orderRank

返回参数

名称类型描述示例值
object

响应结果。

requestIdstring

请求 ID。

CBC799F0-ABCD-1D30-8A4F-882ED4DD****
successboolean

表示业务请求是否成功。

true
httpCodeinteger

业务状态码,统一为 200;使用 success 表示业务请求是否成功。

200
errorCodestring
  • 当 success 为 false,返回业务错误码;

  • 当 success 为 true,返回空值。

""
errorMessagestring
  • 当 success 为 false,返回业务错误信息;

  • 当 success 为 true,返回空值。

""
dataUdfFunction

自定义函数信息。

示例

正常返回示例

JSON格式

{
  "requestId": "CBC799F0-ABCD-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": {
    "functionName": "myFunction",
    "udfArtifactName": "udfCollection.jar",
    "className": "myFunctionTest"
  }
}

错误码

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