文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>API 中心>腾讯云 BI>数据库表相关接口>原始数据表字段接口

原始数据表字段接口

最近更新时间：2026-06-04 01:14:54

我的收藏

本页目录：

1. 接口描述

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

原始数据表字段接口信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeSourceFieldList。
Version 是 String 公共参数，本接口取值：2022-01-05。
Region 否 String 公共参数，此参数为可选参数。
DataSourceId 否 Integer 数据源Id
示例值：1
TableName 否 String 表名
示例值：table
Sql 否 String sql内容
示例值：table
ProjectId 否 Integer 项目id
示例值：1
AsyncRequest 否 Boolean 是否是异步
示例值：true
TranId 否 String 异步事务id
示例值：1
ParamList.N 否 Array of ParamCreateDTO 11
DlcExtInfo 否 String DLC扩展参数
示例值：{"id":1}
QueryDbData 否 String 是否查询数据库
示例值：1
TableId 否 String 数据表 Id
示例值：1
TableType 否 Integer 后端提供字典：数据表类型，1、数据库建表，2、SQL建表，3、Excel上传，4、API接入，5、腾讯文档，6、云数据库，7、手工输入，8、关联查询
示例值：1

3. 输出参数

参数名称 类型 描述
ErrorInfo ErrorInfo 自定义错误信息对象
注意：此字段可能返回 null，表示取不到有效值。
Extra String 额外信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"msg":"额外信息"}
Msg String 信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：success
Data TableColumnListData 表中字段的列表
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 原始数据表字段接口

原始数据表字段接口

输入示例

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

{
    "DataSourceId": 0,
    "TableName": "testdata",
    "Sql": "testdata",
    "ProjectId": 1,
    "AsyncRequest": true,
    "TranId": "testdata",
    "DlcExtInfo": "testdata",
    "ParamList": [
        {
            "ParamName": "testdata",
            "DefaultValue": "testdata",
            "ParamType": "testdata",
            "FormatRule": "testdata",
            "ComplexType": "testdata"
        }
    ]
}

输出示例

{
    "Response": {
        "Extra": "testdata",
        "Msg": "testdata",
        "Data": {
            "List": [
                {
                    "DbName": "testdata",
                    "AliasName": "testdata",
                    "DbType": "testdata",
                    "FieldType": "testdata",
                    "Mark": "testdata",
                    "ExcelName": "testdata",
                    "DictId": 0,
                    "DictName": "testdata",
                    "TableNodeId": "testdata",
                    "TableName": "testdata",
                    "FieldComplexType": "testdata",
                    "FormatRule": "testdata",
                    "IsFilter": true,
                    "CalcType": "testdata",
                    "CalcFormula": "testdata",
                    "CalcDesc": "testdata",
                    "JsonPathName": "testdata",
                    "Granularity": "testdata"
                }
            ],
            "TranId": "testdata",
            "TranStatus": 0
        },
        "RequestId": "testdata"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.Internal 内部错误。
MissingParameter.MissingParam 必填参数缺失。
UnauthorizedOperation.Authorize 权限错误。
UnsupportedOperation.BIError 默认业务异常。
中国站