描述Catalog信息 - ShowCatalog
功能介绍
该API用于查询指定的DLI Catalog详情。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
Action
访问级别
Access Level
资源类型（*为必须）
Resource Type (*: required)
条件键
Condition Key
别名
Alias
依赖的授权项
Dependencies
dli:catalog:get
Read
-
-
-
-
URI
GET /v3/{project_id}/catalogs/{catalog_name}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目编号，用于资源隔离。获取方式请参考获取项目ID。 |
|
catalog_name |
是 |
String |
DLI侧Catalog映射名称。 |
请求参数
无
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
is_success |
Boolean |
是否成功。 |
|
name |
String |
DLI侧Catalog映射名称。 |
|
create_time |
Long |
创建时间 |
|
parameters |
Map<String,String> |
Catalog结构信息。请参考表3。 |
|
description |
String |
Catalog描述信息。 |
|
status |
String |
Catalog状态。
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
external_catalog_name |
String |
外部Catalog名称。 |
|
type |
String |
Catalog类型，当前仅支持lakeformation。 lakeformation：使用Lakeformation类型的元数据。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
失败原因 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
失败原因 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
失败原因 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
失败原因 |
请求示例
无
响应示例
{
"is_success": true,
"name": "dli_catalog_test1",
"create_time": 1709605019153,
"parameters": {
"type": "lakeformation",
"external_catalog_name": "catalog_test1"
},
"description": ""
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
请求错误。 |
|
403 |
对被请求页面的访问被禁止。 |
|
404 |
服务器无法找到被请求的页面。 |
|
500 |
内部服务器错误。 |
错误码
请参见错误码。
