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

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
CatalogId String Query 1344371

数据库分类命名空间,默认填写主账号Uid

DatabaseName String Query database_test

元数据库名称

FunctionNamePattern String Query .*

用户定义函数名的正则匹配表达式

NextPageToken String Query 2cb472ec1bf84f8d92f9c4baa0d21c19aa

翻页token,从返回结果返回,无则传空字符串或''

PageSize Integer Query 10

每页大小

RegionId String Host cn-hangzhou

系统所在的地域ID

返回数据

名称 类型 示例值 描述
Code String OK

状态码描述

Functions Array of Function

函数详情列表

Message String .

提示相关错误信息

NextPageToken String 2cb472ec1bf84f8d92f9c4baa0d21c19aa

翻页token

RequestId String B7F4B621-E41E-4C84-B97F-42B5380A32BB

请求ID

Success Boolean true

是否成功

Code错误码说明

InternalError:其他类型错误,请参考Message提示

示例

请求示例

GET /api/metastore/catalogs/databases/functions/list HTTP/1.1 
 {
	"FunctionNamePattern":".*",
	"PageSize":"10",
	"NextPageToken":"2cb472ec1bf84f8d92f9c4baa0d21c19aa",
	"DatabaseName":"database_test",
	"RegionId":"cn-hangzhou",
	"CatalogId":"1344371"
}

正常返回示例

JSON 格式

{
  "Code": "OK",
  "Functions": [{
    "CatalogId": "1344371",
    "ClassName": "com.xxx.xxxxFunction",
    "CreateTime": 1608863962,
    "DatabaseName": "database_test",
    "FunctionName": "func2",
    "FunctionType": "JAVA",
    "OwnerName": "zhangsan",
    "OwnerType": "USER",
    "ResourceUri": [
      {
        "ResourceType": "JAR",
        "Uri": "hdfs:///tmp/jar1.jar"
      }
    ],
    "UpdateTime": 1608863962
  }],
  "HttpStatusCode": 200,
  "Message": "",
  "RequestId": "1A894339-A288-4FE6-811F-6E14B4F62704",
  "Success": true
}

错误码

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

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