本文导读

功能介绍
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ LakeCat/ 数据库管理/ 创建数据库

创建数据库

更新时间：2025-04-21 GMT+08:00

查看PDF

功能介绍

创建数据库。

调试

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

URI

POST /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目编号。获取方法，请参见获取项目ID。
instance_id	是	String	LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。
catalog_name	是	String	catalog名称。只能包含字母、数字和下划线，且长度为1~256个字符。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	Array of strings	租户token。

表3 请求Body参数
参数	是否必选	参数类型	描述
database_name	是	String	数据库名称。只能包含中文、字母、数字、下划线、中划线，且长度为1~128个字符。
external_database_id	否	String	用户端数据库id，创建时指定，不可修改。
owner	否	String	数据库所有者。长度为0~128个字符。
owner_type	否	String	所有者类型：USER-用户、GROUP-组、ROLE-角色。LakeFormation服务分为一期和二期，一期响应Body无该参数。
owner_auth_source_type	否	String	所有者来源：IAM-云用户、SAML-联邦、LDAP-ld用户、LOCAL-本地用户、AGENTTENANT-委托、OTHER-其它。LakeFormation服务分为一期和二期，一期响应Body无该参数。
description	否	String	数据库描述信息。由用户创建数据库时输入，最大长度为4000个字符。
location	否	String	数据库路径地址。例如obs://location/uri/。
parameters	否	Map<String,String>	标签信息。
table_location_list	否	Array of strings	表路径列表。
function_location_list	否	Array of strings	函数路径列表。
data_statistic_enable	否	Boolean	数据概况统计开关。默认状态为关，若要开启database下table的数据概况统计，需要先打开database的数据概况开关

响应参数

状态码：201

表4 响应Body参数
参数	参数类型	描述
catalog_name	String	catalog名称。
catalog_id	String	catalogID。
database_name	String	数据库名称。
database_id	String	数据库ID。
database_status	Integer	数据库状态：0表示正常，1表示删除中，2表示已删除，3表示恢复中，4表示清除中。
external_database_id	String	用户端数据库id，创建时指定，不可修改。
owner	String	数据库所有者。
owner_type	String	所有者类型：USER-用户、GROUP-组、ROLE-角色。
owner_auth_source_type	String	所有者授权来源类型：IAM-云用户、SAML-联邦、LDAP-ld用户、LOCAL-本地用户、AGENTTENANT-委托、OTHER-其它。LakeFormation服务分为一期和二期，一期响应Body无该参数。
description	String	数据库描述信息。
location	String	数据库路径地址。例如obs://location/uri/。
data_statistic_enable	Boolean	数据概况统计开关。默认状态为关，若要开启database下table的数据概况统计，需要先打开database的数据概况开关。database此开关开启后，database下所有table都会默认开启此开关
parameters	Map<String,String>	参数信息。
table_location_list	Array of strings	表路径列表。LakeFormation服务分为一期和二期，一期响应Body无该参数，二期默认为null。当值为null时，响应Body无该参数。
function_location_list	Array of strings	函数路径列表。默认为null，当值为null时，响应Body无该参数。
update_time	String	数据库元数据最后一次修改时间。
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	解决方案描述。

请求示例

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

{
  "database_name" : "db8a9ea595e6a14db1bdb3c3a90bf2554c",
  "owner" : "owner",
  "owner_type" : "USER",
  "description" : "description",
  "location" : "obs://location/test/db8a9ea595e6a14db1bdb3c3a90bf2554c.db",
  "parameters" : {
    "transient_lastDdlTime" : "120",
    "comment" : "comment message",
    "classification" : "other"
  }
}

响应示例

状态码：201

Created

{
  "catalog_name" : "catalog0b5633ba2b904511ad514346f4d23d4b",
  "database_name" : "db8a9ea595e6a14db1bdb3c3a90bf2554c",
  "owner" : "owner",
  "owner_type" : "USER",
  "description" : "description",
  "location" : "obs://location/test/db8a9ea595e6a14db1bdb3c3a90bf2554c.db",
  "parameters" : {
    "transient_lastDdlTime" : "120",
    "comment" : "comment message",
    "classification" : "other"
  },
  "table_location_list" : [ ],
  "function_location_list" : [ ]
}

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

状态码


状态码	描述
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
408	Request Timeout
500	Internal Server Error

错误码

请参见错误码。

父主题： 数据库管理

上一篇：列举数据库信息

下一篇：获取数据库

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问