创建Catalog
功能介绍
创建Catalog，会在Catalog下创建默认数据库，默认数据库名称为：default。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/instances/{instance_id}/catalogs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目编号。获取方法，请参见获取项目ID。 |
|
instance_id |
是 |
String |
LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
Array of strings |
租户token。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
catalog_name |
是 |
String |
catalog名称。只能包含字母、数字和下划线，且长度为1~256个字符。 |
|
description |
否 |
String |
描述信息。最大长度为4000个字符。 |
|
location |
否 |
String |
路径地址。例如obs://location/uri/。 |
|
database_location_list |
否 |
Array of strings |
数据库路径列表。最小条目数为0，最大条目数为1000。 |
|
branch_name |
否 |
String |
分支名称。只能包含字母、数字和下划线，且长度为1~32个字符。默认值为main。 |
|
owner |
否 |
String |
catalog所有者。只能包含字母、数字和下划线，且最大长度为128个字符。 |
|
owner_type |
否 |
String |
所有者类型：USER-用户、GROUP-组、ROLE-角色。 |
|
owner_source |
否 |
String |
所有者来源：IAM-云用户、SAML-联邦、LDAP-ld用户、LOCAL-本地用户、AGENTTENANT-委托、OTHER-其它。 |
|
type |
否 |
String |
catalog类型，可选值为DEFAULT（代表默认的元数据类型）、CLICKHOUSE（代表CH类型），不设置时默认为DEFAULT。 创建时指定，不可修改。 |
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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-ld用户、LOCAL-本地用户、AGENTTENANT-委托、OTHER-其它。LakeFormation服务分为一期和二期，一期响应Body无该参数。 |
|
type |
String |
catalog类型，可选值为DEFAULT（代表默认的元数据类型）、CLICKHOUSE（代表CH类型），不设置时默认为DEFAULT。 创建时指定，不可修改。 |
|
update_time |
String |
catalog元数据最后一次修改时间。 |
|
version_id |
String |
版本ID |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
solution_msg |
String |
解决方案描述。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
solution_msg |
String |
解决方案描述。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Error object |
错误信息。 |
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
title |
String |
标题。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
title |
String |
标题。 |
|
message |
String |
错误信息。 |
|
code |
String |
状态码。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
solution_msg |
String |
解决方案描述。 |
状态码：408
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
solution_msg |
String |
解决方案描述。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
solution_msg |
String |
解决方案描述。 |
请求示例
POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/catalogs
{
"catalog_name" : "hive",
"description" : "Default catalog, for Hive",
"location" : "obs://lakeformation/test",
"database_location_list" : null,
"owner" : "admin",
"owner_type" : "USER",
"owner_source" : "IAM"
}
响应示例
状态码：201
Created
{
"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"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
408 |
Request Timeout |
|
500 |
Internal Server Error |
错误码
请参见错误码。
