调用ListFunctions获取元数据库的函数列表_数据湖构建(DLF)-阿里云帮助中心

批量获取数据湖元数据库的用户自定义函数列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dlf:ListFunctions	LIST	全部资源 *	无	无

请求语法

GET /api/metastore/catalogs/databases/functions/list

请求参数

名称	类型	必填	描述	示例值
CatalogId	string	否	数据库分类命名空间，默认填写主账号 Uid	1344371
DatabaseName	string	否	元数据库名称	database_test
FunctionNamePattern	string	否	用户定义函数名的正则匹配表达式	.*
NextPageToken	string	否	翻页 token，从返回结果返回，无则传空字符串或''	2cb472ec1bf84f8d92f9c4baa0d21c19aa
PageSize	integer	否	每页大小	10

返回参数

名称	类型	描述	示例值
	object	返回结果
Code	string	状态码描述	OK
Functions	array	函数详情列表
	Function	函数描述详情
Message	string	提示相关错误信息	.
NextPageToken	string	翻页 token	2cb472ec1bf84f8d92f9c4baa0d21c19aa
RequestId	string	请求 ID	B7F4B621-E41E-4C84-B97F-42B5380A32BB
Success	boolean	是否成功	true

Code 错误码说明
InternalError：其他类型错误，请参考 Message 提示

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Functions": [
    {
      "CatalogId": "1344371",
      "ClassName": "com.xxx.xxxxFunction",
      "CreateTime": 1608863962,
      "DatabaseName": "database_test",
      "FunctionName": "function1",
      "FunctionType": "JAVA",
      "OwnerName": "zhangsan",
      "OwnerType": "USER",
      "ResourceUri": [
        {
          "ResourceType": "JAR",
          "Uri": "hdfs:///tmp/jar1.jar"
        }
      ],
      "UpdateTime": 1608863962,
      "CreatedBy": "CreatedBy"
    }
  ],
  "Message": ".",
  "NextPageToken": "2cb472ec1bf84f8d92f9c4baa0d21c19aa",
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Success": true
}

JSON格式

{
  "Code": "OK",
  "Functions": [
    {
      "CatalogId": "1344371",
      "ClassName": "com.xxx.xxxxFunction",
      "CreateTime": 1608863962,
      "DatabaseName": "database_test",
      "FunctionName": "function1",
      "FunctionType": "JAVA",
      "OwnerName": "zhangsan",
      "OwnerType": "USER",
      "ResourceUri": [
        {
          "ResourceType": "JAR",
          "Uri": "hdfs:///tmp/jar1.jar"
        }
      ],
      "UpdateTime": 1608863962,
      "CreatedBy": "CreatedBy"
    }
  ],
  "Message": ".",
  "NextPageToken": "2cb472ec1bf84f8d92f9c4baa0d21c19aa",
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Success": true
}

错误码

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