文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>数据开发治理平台 WeData>API 文档>数据开发治理平台 WeData API 2021-08-20>元数据相关接口>查询表的数据预览

查询表的数据预览

最近更新时间：2026-03-18 03:58:55

我的收藏

本页目录：

1. 接口描述

接口请求域名： wedata.tencentcloudapi.com 。

查询表的数据预览

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTableContentPreview。
Version 是 String 公共参数，本接口取值：2021-08-20。
Region 是 String 公共参数，详见产品支持的 地域列表。
TableId 是 String 表ID
示例值：1000
TechnologyType 是 String 组件类型枚举值，支持的值有 HDFS/HBASE/HIVE/KAFKA
示例值：HIVE
ClusterId 是 String 集群id
示例值：emr-111
ResourceType 是 String 资源类型枚举值，支持的值有TOPIC/PATH/TABLE/DATABASE
示例值：TABLE
TableName 是 String 表名
示例值：user
ProjectId 是 String 项目id
示例值：1051972427153674240
RowNum 否 Integer 预览的行数，默认10行
示例值：5
DatabaseName 否 String 数据库名，kafka或其他无数据库概念的不填
示例值：useful
TaskId 否 String 异步查询预览结果时填写
示例值：100
PartitionName 否 String 分区信息
示例值：dt=2025-07-01/region=west

3. 输出参数

参数名称 类型 描述
ColumnNames Array of String 表的列名列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：["col"]
TableRecordSet Array of TableRecord 表的行数据列表
注意：此字段可能返回 null，表示取不到有效值。
TaskId String 异步预览任务ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000
AsyncState Integer 异步预览结果状态: 0 初始化， 1 执行中， 2 执行成功
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 异步预览表信息

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTableContentPreview
<公共请求参数>

{
    "TableId": "lr_At9jPStaeO9p_wMYjsQ",
    "TechnologyType": "ICEBERG",
    "ClusterId": "emr-dbcygrxq",
    "ResourceType": "TABLE",
    "TableName": "t1",
    "ProjectId": "2566642341118603264",
    "DatabaseName": "worinimao"
}

输出示例

{
    "Response": {
        "RequestId": "req_id_***",
        "ColumnNames": [
            "col1",
            "col2",
            "col3",
            "pt_day"
        ],
        "TableRecordSet": [
            {
                "TableRecordFieldSet": [
                    {
                        "Name": "col1",
                        "Value": "value1"
                    },
                    {
                        "Name": "col2",
                        "Value": "value2"
                    },
                    {
                        "Name": "col3",
                        "Value": "value3"
                    },
                    {
                        "Name": "pt_day",
                        "Value": "2026-03-10"
                    }
                ]
            },
            {
                "TableRecordFieldSet": [
                    {
                        "Name": "col1",
                        "Value": "value4"
                    },
                    {
                        "Name": "col2",
                        "Value": "value5"
                    },
                    {
                        "Name": "col3",
                        "Value": "value6"
                    },
                    {
                        "Name": "pt_day",
                        "Value": "2026-03-10"
                    }
                ]
            }
        ],
        "TaskId": "123000",
        "AsyncState": null
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.SignatureExpire 未登录或登录已过期。
FailedOperation 操作失败。
FailedOperation.PreviewTimeOut 数据预览超时
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceNotFound 资源不存在。
中国站
目录