文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ LakeCat类API/ 目录管理/ 修改Catalog信息 - UpdateCatalog
更新时间：2026-08-31 GMT+08:00
查看PDF
分享

修改Catalog信息 - UpdateCatalog

功能介绍

修改Catalog信息。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

PUT /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

长度为1~64个字符

取值范围:

长度为1~64个字符

默认取值:

不涉及

instance_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

catalog_name

是

String

参数解释:

catalog名称。

约束限制:

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

取值范围:

长度为1~256个字符

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

Array of strings

参数解释:

租户token。

约束限制:

数组元素个数为1~100

取值范围:

数组元素个数为1~100

默认取值:

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

catalog_name

是

String

参数解释:

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

约束限制:

长度为1~256个字符

取值范围:

长度为1~256个字符

默认取值:

不涉及

description

否

String

参数解释:

描述信息。最大长度为4000个字符

约束限制:

长度为0~4000个字符

取值范围:

长度为0~4000个字符

默认取值:

不涉及

location

否

String

参数解释:

路径地址。例如obs://location/uri/

约束限制:

最大长度为4000

取值范围:

最大长度为4000

默认取值:

不涉及

database_location_list

否

Array of strings

参数解释:

数据库路径列表。最小条目数为0，最大条目数为1000

约束限制:

最大长度为4000，数组元素个数为0~1000

取值范围:

最大长度为4000，数组元素个数为0~1000

默认取值:

不涉及

branch_name

否

String

参数解释:

分支名称。只能包含字母、数字和下划线，且长度为1~32个字符。默认值为main

约束限制:

长度为1~32个字符

取值范围:

长度为1~32个字符

默认取值:

main

owner

否

String

参数解释:

catalog所有者。只能包含字母、数字和下划线，且最大长度为128个字符

约束限制:

最大长度为128

取值范围:

最大长度为128

默认取值:

不涉及

owner_type

否

String

参数解释:

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

约束限制:

可选值为：USER, ROLE, GROUP

取值范围:

不涉及

默认取值:

不涉及

owner_source

否

String

参数解释:

所有者来源：IAM-云用户、SAML-联邦、LDAP-LDAP用户、LOCAL-本地用户、AGENTTENANT-委托、OTHER-其它

约束限制:

可选值为：IAM, SAML, LDAP, LOCAL, AGENTTENANT, OTHER

取值范围:

不涉及

默认取值:

不涉及

type

否

String

参数解释:

catalog类型，可选值为DEFAULT（代表默认的元数据类型）、CLICKHOUSE（代表CH类型），不设置时默认为DEFAULT。

创建时指定，不可修改

约束限制:

可选值为：DEFAULT, CLICKHOUSE

取值范围:

不涉及

默认取值:

DEFAULT

version_id

否

String

参数解释:

版本ID，可在修改时传入，默认为最新版本

约束限制:

长度为24个字符

取值范围:

长度为24个字符

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

catalog_name

String

参数解释:

catalog名称

catalog_id

String

参数解释:

catalogID

description

String

参数解释:

描述信息

location

String

参数解释:

路径地址。例如obs://location/uri/

database_location_list

Array of strings

参数解释:

数据库路径列表。当值为null时，响应Body无该参数

owner

String

参数解释:

catalog所有者。LakeFormation服务分为一期和二期，一期响应Body无该参数

owner_type

String

参数解释:

所有者类型，USER-用户，GROUP-组，ROLE-角色。LakeFormation服务分为一期和二期，一期响应Body无该参数

owner_source

String

参数解释:

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

type

String

参数解释:

catalog类型，可选值为DEFAULT（代表默认的元数据类型）、CLICKHOUSE（代表CH类型），不设置时默认为DEFAULT。

创建时指定，不可修改

create_time

String

参数解释:

catalog元数据创建时间

update_time

String

参数解释:

catalog元数据最后一次修改时间

version_id

String

参数解释:

版本ID

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

solution_msg

String

参数解释:

解决方案描述

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

solution_msg

String

参数解释:

解决方案描述

状态码：403

表7 响应Body参数

参数

参数类型

描述

error

Error object

参数解释:

错误信息

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

title

String

参数解释:

标题
表8 Error

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

title

String

参数解释:

标题

message

String

参数解释:

错误信息

code

String

参数解释:

状态码

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

solution_msg

String

参数解释:

解决方案描述

状态码：408

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

solution_msg

String

参数解释:

解决方案描述

状态码：500

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

solution_msg

String

参数解释:

解决方案描述

请求示例

PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}

{
  "catalog_name" : "hive",
  "description" : "Default catalog, for Hive",
  "location" : "obs://lakeformation/test",
  "database_location_list" : null,
  "owner" : "admin",
  "owner_type" : "USER",
  "owner_source" : "IAM"
}

响应示例

状态码：200

OK

{
  "catalog_name" : "hive",
  "description" : "Default catalog, for Hive",
  "location" : "obs://lakeformation/test",
  "database_location_list" : null,
  "owner" : "admin",
  "owner_type" : "USER",
  "owner_source" : "IAM"
}

状态码：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

错误码

请参见错误码。

父主题： 目录管理

相关文档