GetDataLakeFunction查询湖仓自定义函数API参考-数据管理 DMS-阿里云

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
CatalogName	string	是	数据目录名。	hive
DbName	string	是	数据库名称。	default
FunctionName	string	是	函数名称。	my_funciton
Tid	integer	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	3****
WorkspaceId	integer	否	工作空间 ID。	12****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，用于定位日志，排查问题。	D911009F-3E95-5AFD-8CF1-73F7B4F1****
ErrorCode	string	请求异常时返回的错误码。	UnknownError
ErrorMessage	string	调用失败时，返回的错误信息。	UnknownError
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
Function	DLFunction	函数的详细信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "D911009F-3E95-5AFD-8CF1-73F7B4F1****",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Function": {
    "FunctionName": "my_funciton",
    "OwnerName": "zhangsan",
    "OwnerType": "USER",
    "CreatorId": 0,
    "FunctionType": "JAVA",
    "CreateTime": 1731586286,
    "ResourceUris": [
      {
        "ResourceType": "JAR",
        "Uri": "hdfs://name****.example.com:8020/user/hive/udfs/my_***.jar"
      }
    ],
    "ClassName": "com.example.hive.MyCustomUDF",
    "CatalogName": "hive",
    "DbName": "default",
    "ModifierId": 0
  }
}

错误码

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

变更历史

更多信息，参考变更详情。