文档首页/数据湖探索 DLI/API参考/数据目录相关API/绑定/解绑catalog映射信息
更新时间：2025-12-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

绑定/解绑catalog映射信息

功能介绍

该API创建DLI绑定/解绑到Lakeformation等服务的元数据目录（Catalog）相关信息，当前只支持Lakeformation。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    Action

    访问级别

    Access Level

    资源类型（*为必须）

    Resource Type (*: required)

    条件键

    Condition Key

    别名

    Alias

    依赖的授权项

    Dependencies

    dli:catalog:bind

    Write

    -

    -

    -

    -

URI

POST /v3/{project_id}/catalogs/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目编号，用于资源隔离。获取方式请参考获取项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

action

是

String

Catalog操作。

  • bind：绑定。
  • unbind：解绑。

name

是

String

DLI侧Catalog映射名称。

最小长度：1

最大长度：128

description

否

String

Catalog的描述信息。

parameters

是

Map<String,String>

Catalog结构信息。请参考表3。

表3 parameters结构参数说明

参数

参数类型

描述

external_catalog_name

String

外部Catalog名称。

当type=lakeformation时，填写需要绑定的lakeformation侧的Catalog名称。

type

String

Catalog类型，当前仅支持lakeformation。

lakeformation：使用Lakeformation类型的元数据。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

message

String

系统提示信息，执行成功时，信息可能为空。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述信息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

失败原因

请求示例

{
 "action": "bind",
 "name": "dli_catalog_test1",
 "parameters": {
  "external_catalog_name": "catalog_test1",
  "type": "lakeformation"
 }
}

响应示例

状态码： 403

Forbidden

{
  "error_code" : "DLI.0003",
  "error_msg" : "Forbidden"
}

状态码： 404

Not Found

{
  "error_code" : "DLI.0002",
  "error_msg" : "Not Found"
}

状态码： 500

Internal Server Error

{
  "error_code" : "DLI.0999",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

请求成功。

400

请求错误。

403

对被请求页面的访问被禁止。

404

服务器无法找到被请求的页面。

500

内部服务器错误。

错误码

请参见错误码。