租户端 大数据 大数据处理套件（TBDS） 数据管理接口 获取表详情

获取表详情

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

1. 接口描述

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

获取指定database下某个表详情.

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

接口更新时间：2025-09-11 17:40:13。

接口既验签名又鉴权。

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
Data DescribeTableResult 表详情
注意：此字段可能返回 null，表示取不到有效值。
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

5. 示例

示例1 获取表详情

输入示例

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

{
  "TableIdentity": {
    "CatalogName": "c9kr93vco_hive",
    "SchemaName": "default",
    "TableName": "table1"
  }
}

输出示例

{
  "Response": {
    "RequestId": "3dd9c1ee-00e8-42ff-8fff-35aa52eaebc9",
    "Data": {
      "TableSimpleInfo": {
        "TableName": "table1",
        "Desc": "",
        "CreateTime": "2025-05-27 11:35:49",
        "CreateUser": "grace",
        "OptimizationType": null
      },
      "TableFormat": "hive",
      "PropertyList": [
        {
          "Key": "input-format",
          "Value": "org.apache.hadoop.mapred.TextInputFormat",
          "ReadOnly": true
        },
        {
          "Key": "owner",
          "Value": "grace",
          "ReadOnly": true
        },
        {
          "Key": "create_time",
          "Value": "1748316948",
          "ReadOnly": true
        },
        {
          "Key": "transient_lastDdlTime",
          "Value": "1748316949",
          "ReadOnly": true
        },
        {
          "Key": "output-format",
          "Value": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat",
          "ReadOnly": true
        },
        {
          "Key": "location",
          "Value": "hdfs://HDFS78000003/usr/hive/warehouse/table1",
          "ReadOnly": true
        },
        {
          "Key": "table-type",
          "Value": "MANAGED_TABLE",
          "ReadOnly": true
        },
        {
          "Key": "create_user",
          "Value": "grace",
          "ReadOnly": true
        },
        {
          "Key": "serde-lib",
          "Value": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
          "ReadOnly": true
        },
        {
          "Key": "serde-name",
          "Value": "table1",
          "ReadOnly": true
        }
      ],
      "CreateTableWay": "OTHER",
      "FieldSize": 1,
      "OptimizationType": 1,
      "OpenOptimization": 0,
      "OptimizeInfo": {
        "ResourceName": null,
        "FileMergeInfo": {
          "MaxFileSize": null
        },
        "FileCleanInfo": {
          "SnapshotExpireTime": null,
          "IsolateFileRunCycle": null
        }
      }
    }
  }
}