文档

GetUdfArtifacts - 获取自定义函数资源详情

更新时间:

获取您上传并创建的包含UDF的Jar或者Python文件的详情信息。

调试

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

授权信息

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

请求语法

GET /api/v2/namespaces/{namespace}/udfartifacts

请求参数

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

工作空间 ID。

710d6a64d8c34d
namespacestring

项目空间名称。

default-namespace
udfArtifactNamestring

UDF 对应的 Jar 或者 Python 文件的名称。

test-udf

返回参数

名称类型描述示例值
object

响应数据。

requestIdstring

请求 ID。

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

表示业务请求是否成功。

true
httpCodeinteger

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

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

  • 当 success 为 true,返回空值。

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

  • 当 success 为 true,返回空值。

""
dataarray

当 success 为 true,返回满足条件的 UDF 的 Jar 或者 Python 文件的详情;当 success 为 false,该值为空。

UdfArtifact

自定义函数资源详情。

示例

正常返回示例

JSON格式

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": [
    {
      "namespace": "default-namespace\n",
      "creator": "userA",
      "createdAt": 1723532876,
      "modifiedAt": 1723537876,
      "name": "udfCollection.jar\n",
      "jarUrl": "oss://bucket/udfCollection.jar\n",
      "dependencyJarUris": [
        "oss://bucket/addition/add.jar\n"
      ],
      "artifactType": "ARTIFACT_TYPE_JAVA",
      "udfClasses": [
        {
          "udfArtifactName": "udfCollection.jar",
          "className": "myfunctionTest",
          "classType": "UDF_TYPE_TABLE_AGGREGATE",
          "functionNames": [
            "myfunction"
          ]
        }
      ]
    }
  ]
}

错误码

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