文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ LakeCat/ 目录管理/ 列举Catalog信息
更新时间：2024-10-22 GMT+08:00
查看PDF
分享

列举Catalog信息

功能介绍

根据Catalog名称。只能包含字母、数字和下划线，且长度为1~256个字符的通配符列举Catalog的详细信息。

调试

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

URI

GET /v1/{project_id}/instances/{instance_id}/catalogs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

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

参数

是否必选

参数类型

描述

deleted

否

Boolean

是否查询被删除元数据。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

Array of strings

租户token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of Catalog objects

OK
表5 Catalog

参数

参数类型

描述

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无该参数。

枚举值：

  • USER

  • ROLE

  • GROUP

owner_source

String

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

枚举值：

  • IAM

  • SAML

  • LDAP

  • LOCAL

  • AGENTTENANT

  • OTHER

type

String

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

枚举值：

  • DEFAULT

  • CLICKHOUSE

update_time

String

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

version_id

String

版本ID

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

请求示例

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/catalogs

响应示例

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

错误码

请参见错误码。

父主题： 目录管理