GetDataLakeFunction

Updated at:

Retrieves the details of a user-defined function in a data lake.

Try it now

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

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

CatalogName

string

Yes

The name of the data catalog.

hive

DbName

string

Yes

The name of the database.

default

FunctionName

string

Yes

The name of the function.

my_funciton

Tid

integer

No

The tenant ID.

Note

Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see View tenant information.

3****

WorkspaceId

integer

No

The workspace ID.

12****

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The request ID, used for log tracing and troubleshooting.

D911009F-3E95-5AFD-8CF1-73F7B4F1****

ErrorCode

string

The error code returned if the request fails.

UnknownError

ErrorMessage

string

The error message returned if the request fails.

UnknownError

Success

boolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.

  • false: The request fails.

true

Function

DLFunction

The details of the function.

Examples

Success response

JSON format

{
  "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
  }
}

Error codes

See for a complete list.

Release notes

See 变更详情 for a complete list.