获取catalog详情

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

1. 接口描述

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

获取元数据catalog 详情信息。比如描述信息。针对于iceberg catalog 会额外获取到对应的表优化开关信息

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

接口更新时间：2025-09-12 14:51:49。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeCatalog
Version 是 否 String 公共参数，本接口取值：2019-01-03
Region 是 否 String 公共参数，地域信息本接口不需要传递此参数。
CatalogName 是 否 String catalog 名
示例值： c9kr93vco_hive

3. 输出参数

参数名称 类型 描述
Data CatalogResponse catalog详情返回信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：查看
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: DescribeCatalog
<公共请求参数>

{
  "CatalogName": "c9kr93vco_hive"
}

输出示例

{
        "Response": {
            "RequestId": "903ce7b9-f8ef-4c16-a5d5-8a22070aeb2a",
            "Data": {
                "ClusterId": "tbds-9kr93vco",
                "CatalogName": "c9kr93vco_hive",
                "Desc": "tbds-catalog",
                "Location": "/usr/hive/warehouse",
                "OptimizationType": 0,
                "OptimizeInfo": {
                    "ResourceName": null,
                    "FileMergeInfo": {
                        "MaxFileSize": null
                    },
                    "FileCleanInfo": {
                        "SnapshotExpireTime": null,
                        "IsolateFileRunCycle": null
                    }
                }
            }
        }
    }