文档

GetFunction - 获取元数据库的指定函数

根据函数名称,获取数据湖元数据库的用户自定义函数。

调试

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

授权信息

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

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

请求语法

GET /api/metastore/catalogs/databases/functions

请求参数

名称类型必填描述示例值
CatalogIdstring

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

1344371
DatabaseNamestring

元数据库名称

database_test
FunctionNamestring

用户定义函数名

func2

返回参数

名称类型描述示例值
object

返回结果

Codestring

状态码描述

OK
FunctionFunction

函数描述详情

Messagestring

提示相关错误信息

.
RequestIdstring

请求 ID

B7F4B621-E41E-4C84-B97F-42B5380A32BB
Successboolean

是否成功

true

Code 错误码说明
InternalError:请参考 Message 提示

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Function": {
    "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": ".",
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Success": true
}

JSON格式

{
  "Code": "OK",
  "Function": {
    "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": ".",
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Success": true
}

错误码

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

  • 本页导读 (0)
文档反馈