1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
查询表所有字段列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetTableColumns。 |
Version | 是 | String | 公共参数,本接口取值:2025-08-06。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TableGuid | 是 | String | 数据表GUID 示例值:byV1bs2QGzbTepNlHhi2gA |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | Array of ColumnInfo | 表字段列表 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询表列信息
查询表列信息
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTableColumns
<公共请求参数>
{
"TableGuid": "byV1bs2QGzbTepNlHhi2gA"
}
输出示例
{
"Response": {
"Data": [
{
"Description": "",
"IsPartition": false,
"Length": 0,
"Name": "tinyint_col",
"Position": 0,
"Type": "tinyint"
},
{
"Description": "",
"IsPartition": false,
"Length": 0,
"Name": "smallint_col",
"Position": 1,
"Type": "smallint"
},
{
"Description": "",
"IsPartition": false,
"Length": 0,
"Name": "int_col",
"Position": 2,
"Type": "int"
},
{
"Description": "",
"IsPartition": false,
"Length": 0,
"Name": "bigint_col",
"Position": 3,
"Type": "bigint"
},
{
"Description": "",
"IsPartition": false,
"Length": 0,
"Name": "boolean_col",
"Position": 4,
"Type": "boolean"
},
{
"Description": "",
"IsPartition": false,
"Length": 0,
"Name": "float_col",
"Position": 5,
"Type": "float"
},
{
"Description": "",
"IsPartition": false,
"Length": 0,
"Name": "double_col",
"Position": 6,
"Type": "double"
},
{
"Description": "",
"IsPartition": false,
"Length": 0,
"Name": "string_col",
"Position": 7,
"Type": "string"
},
{
"Description": "",
"IsPartition": false,
"Length": 0,
"Name": "timestamp_col",
"Position": 8,
"Type": "timestamp"
},
{
"Description": "",
"IsPartition": false,
"Length": 0,
"Name": "decimal_col",
"Position": 9,
"Type": "decimal(10,2)"
},
{
"Description": "",
"IsPartition": true,
"Length": 0,
"Name": "date_col",
"Position": 10000,
"Type": "date"
}
],
"RequestId": "386ce7d5-5828-4b07-9e77-58a6bc311a6d"
}
}
示例2 OpenAPI-查询表列信息
OpenAPI-查询表列信息
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTableColumns
<公共请求参数>
{
"TableGuid": "bONctN4uSTN9qL_im1kfYA"
}
输出示例
{
"Response": {
"Data": [],
"RequestId": "e4f9c44d-a371-462c-9f4a-d294421d5ab4"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
UnauthorizedOperation | 未授权操作。 |