ListDataLakeFunction - 获取数据湖函数列表 - 数据管理 DMS

调用此API可获取数据湖函数列表。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:ListDataLakeFunction

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DataRegion	string	是	数据湖所属的地域。	cn-hangzhou
Tid	integer	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	3***
CatalogName	string	是	数据目录名。	hive
DbName	string	否	数据库名称。	default
FunctionNamePattern	string	否	函数名匹配的正则表达式，用于过滤返回的函数名称。	.*
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	f056501ada12c1cc
MaxResults	integer	否	分页大小。最大值为 100。	20
WorkspaceId	integer	否	工作空间 ID。	12****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求的 ID。用于定位日志，排查问题。	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
Success	boolean	请求是否成功。返回值如下： true：请求成功 false：请求失败	true
ErrorCode	string	调用失败时，返回的错误码。	UnknownError
ErrorMessage	string	调用失败时，返回的错误信息。	UnknownError
FunctionList	array	函数列表。
	DLFunction	函数信息。
NextToken	string	下一次查询的令牌（Token）。	f056501ada12c1cc
MaxResults	integer	分页大小。	20

示例

正常返回示例

JSON格式

{
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "FunctionList": [
    {
      "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
    }
  ],
  "NextToken": "f056501ada12c1cc",
  "MaxResults": 20
}

错误码

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

变更历史

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