文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ LakeCat/ 函数管理/ 列举函数
更新时间：2024-10-22 GMT+08:00
查看PDF
分享

列举函数

功能介绍

列举函数。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/{database_name}/functions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目编号。获取方法，请参见获取项目ID。

instance_id

是

String

LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。

catalog_name

是

String

catalog名称。只能包含字母、数字和下划线，且长度为1~256个字符。

database_name

是

String

数据库名称。只能包含中文、字母、数字、下划线、中划线，且长度为1~128个字符。
表2 Query参数

参数

是否必选

参数类型

描述

function_name_pattern

否

String

函数名称通配符。只能包含字母、数字和_|*.特殊字符，且最大长度为256个字符。

limit

否

Integer

查询返回条数。默认值为1000。最小值为1，最大值为2000。

marker

否

String

查询的起始记录ID。最小长度为0，最大长度为256。

reverse_page

否

Boolean

是否倒序查询。

deleted

否

Boolean

是否查询被删除元数据。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

Array of strings

租户token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

page_info

PagedInfo object

分页信息。

functions

Array of Function objects

函数。
表5 PagedInfo

参数

参数类型

描述

current_count

Integer

本次返回的对象个数。最小值为0，最大值为2000。

next_marker

String

下一页查询地址。当不存在下一页，则值为null，当值为null时，响应Body无该参数。

previous_marker

String

上一页查询地址。当不存在上一页，则值为null，当值为null时，响应Body无该参数。
表6 Function

参数

参数类型

描述

catalog_name

String

catalog名称。

catalog_id

String

catalogID。

database_name

String

数据库名称。

database_id

String

数据库ID。

function_name

String

函数名称。只能包含字母、数字和下划线，且长度为1~256个字符。

function_type

String

函数类型,JAVA,remoteUDF。

枚举值：

  • JAVA

  • remoteUDF

function_id

String

函数ID。

owner

String

函数所有者。只能包含字母、数字和下划线，且长度为1~256个字符。

owner_type

String

所有者类型：USER-用户、GROUP-组、ROLE-角色。

枚举值：

  • USER

  • GROUP

  • ROLE

owner_auth_source_type

String

所有者授权来源类型：IAM-云用户、SAML-联邦、LDAP-ld用户、LOCAL-本地用户、AGENTTENANT-委托、OTHER-其它。LakeFormation服务分为一期和二期，一期响应Body无该参数。

枚举值：

  • IAM

  • SAML

  • LDAP

  • LOCAL

  • AGENTTENANT

  • OTHER

class_name

String

函数类名。

create_time

String

创建时间格式为yyyy-mm-ddThh:mm:sss。

update_time

String

函数元数据最后一次修改时间。

resource_uris

Array of FunctionResourceUri objects

函数地址信息。

version_id

String

版本ID
表7 FunctionResourceUri

参数

参数类型

描述

type

String

函数包类型：JAR，FILE，ARCHIVE，URI。

枚举值：

  • JAR

  • FILE

  • ARCHIVE

  • URI

uri

String

函数包地址信息。

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

请求示例

GET https://{endpoint} /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/{database_name}/functions

响应示例

状态码： 200

OK

{
  "page_info" : {
    "current_count" : 2,
    "next_marker" : null,
    "previous_marker" : null
  },
  "functions" : [ {
    "catalog_name" : "catalog_1",
    "database_name" : "database",
    "function_name" : "123kk",
    "function_type" : "JAVA",
    "owner" : "owner_1",
    "owner_type" : "USER",
    "owner_auth_source_type" : "IAM",
    "class_name" : "lxy",
    "create_time" : "2022-12-08T08:18:54.000+00:00",
    "resource_uris" : [ {
      "type" : "FILE",
      "uri" : "obs://lakeformation-test/test2/6/"
    } ]
  }, {
    "catalog_name" : "catalog_2",
    "database_name" : "database",
    "function_name" : "1456",
    "function_type" : "JAVA",
    "owner" : "owner_2",
    "owner_type" : "USER",
    "owner_auth_source_type" : "IAM",
    "class_name" : "34",
    "create_time" : "2022-12-09T01:50:56.000+00:00",
    "resource_uris" : [ {
      "type" : "JAR",
      "uri" : "obs://lakeformation-test/"
    }, {
      "type" : "FILE",
      "uri" : "obs://lakeformation-test/test3/"
    } ]
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码： 401

Unauthorized

{
  "error_code": 'APIG.1002',
  "error_msg": 'Incorrect token or token resolution failed'
}

状态码： 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码： 404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码： 408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码： 500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

错误码

请参见错误码。

父主题： 函数管理

相关文档