获取catalog列表

最近更新时间: 2026-07-12 00:25:30

1. 接口描述

接口请求域名: tbdsnew.api3.fincloud.tencent.com。

获取元数据 catalog 列表。

默认接口请求频率限制:20次/秒。

接口更新时间:2025-09-12 14:52:11。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeCatalogList
Version String 公共参数,本接口取值:2019-01-03
Region String 公共参数,地域信息本接口不需要传递此参数。
Filters Array of RequestFilter 过滤字段,Name支持字段:CatalogName(catalog的名称)和CreateUser(创建人)
示例值:查看
Limit Int64 每页数量,默认值为10,最大值为200
示例值: 9999
Offset Int64 偏移量,页编号,默认为0,表示第一页
示例值: 0
OrderFields Array of OrderField 排序字段,Fields支持字段:创建时间CreateTime,Direction支持"DESC"和"ASC"
示例值:查看
CatalogType String 过滤的catalog类型, 为"hive"或者"iceberg"
示例值: 1

3. 输出参数

参数名称 类型 描述
Data Array of CatalogSimpleInfo catalog列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:查看
TotalCount Int64 总数
示例值: 1
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
FailedOperation 操作失败。