获取catalog列表

最近更新时间: 2026-09-17 00:05:49

1. 接口描述

接口请求域名： tbdsnew.api3.fincloud.tencent.cn。

获取元数据 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 操作失败。

5. 示例

示例1 获取catalog 列表

输入示例

POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeCatalogList
<公共请求参数>

{
  "Offset": 0,
  "Limit": 9999
}

输出示例

{
        "Response": {
            "RequestId": "9d0cdd1a-6418-4ddf-993f-d7535629ed87",
            "Data": [
                {
                    "ClusterId": "tbds-9kr93vco",
                    "ClusterName": "hadoop-多master",
                    "CatalogName": "c9kr93vco_hive",
                    "Desc": "tbds-catalog",
                    "OptimizationType": 0,
                    "CreateTime": "2025-05-27 07:56:43",
                    "CreateUser": "tenantA",
                    "CatalogType": "hive"
                },
                {
                    "ClusterId": "tbds-9kr93vco",
                    "ClusterName": "hadoop-多master",
                    "CatalogName": "c9kr93vco_iceberg",
                    "Desc": "tbds-catalog",
                    "OptimizationType": 0,
                    "CreateTime": "2025-05-27 07:56:43",
                    "CreateUser": "tenantA",
                    "CatalogType": "iceberg"
                }
            ],
            "TotalCount": 2
        }
    }