更新时间：2025-08-06 GMT+08:00
获取项目下所有Catalog信息
功能介绍
该API获取指定项目下所有Catalog信息。
URI
GET /v3/{project_id}/catalogs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目编号，用于资源隔离。获取方式请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
偏移量，默认值为“0”。 |
|
limit |
否 |
Integer |
每页显示的返回信息的个数，默认值为“100”。 |
请求参数
无
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
is_success |
Boolean |
是否成功。 |
|
total_count |
Long |
Catalog总数量。 |
|
catalogs |
Array of objects |
项目下所有Catalog信息。请参考CatalogEntity。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
DLI侧Catalog映射名称。 |
|
create_time |
Long |
Catalog创建时间。 |
|
parameters |
Map<String,String> |
Catalog属性中包含type和externalCatalog。 |
|
description |
String |
Catalog的描述信息。 |
|
status |
String |
Catalog状态。
|
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述信息。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
失败原因。 |
请求示例
无
响应示例
{
"is_success": true,
"total_count": 2,
"catalogs": [
{
"name": "catalog_test1",
"create_time": 1697179174000,
"parameters": {
"type": "lakeformation",
"external_catalog_name": "lakeformation_catalog_test1"
},
"description": "dli default catalog"
},
{
"name": "catalog_test2",
"create_time": 1706595479942,
"parameters": {
"type": "lakeformation",
"external_catalog_name": "lakeformation_catalog_test2"
},
"description": ""
}
]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
请求错误。 |
|
403 |
对被请求页面的访问被禁止。 |
|
404 |
服务器无法找到被请求的页面。 |
|
500 |
内部服务器错误。 |
错误码
请参见错误码。
父主题： 数据目录相关API
