1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
查询表的所有列元数据
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeColumnsMeta。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| TableId | 是 | String | 表ID 示例值：111 |
| PageNumber | 是 | Integer | 页码 示例值：1 |
| PageSize | 是 | Integer | 每页大小 示例值：10 |
| FilterSet.N | 否 | Array of Filter | 过滤器 |
| OrderFieldSet.N | 否 | Array of OrderField | 排序字段 |
| IsPartitionQuery | 否 | Boolean | 是否查询分区字段，默认false 示例值：false |
| ComplianceId | 否 | Integer | 合规组ID |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ColumnMetaSet | Array of ColumnMeta | 分页返回的 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalCount | Integer | 总记录数 示例值：3 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 失败
失败
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeColumnsMeta
<公共请求参数>
{
"TableId": "111",
"PageNumber": 1,
"PageSize": 1
}输出示例
{
"Response": {
"Error": {
"Code": "FailedOperation",
"Message": "DescribeColumnsMeta出错了，原因：元数据 MetaDataClient.describeColumnPageByTableName 接口出错了"
},
"RequestId": "9eba5f8a-8cf5-4ce1-a557-b5d8e624a9b9"
}
}示例2 失败2
失败2
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeColumnsMeta
<公共请求参数>
{
"TableId": "1",
"PageNumber": 1,
"PageSize": 1
}输出示例
{
"Response": {
"Error": {
"Code": "FailedOperation",
"Message": "DescribeColumnsMeta出错了，原因：元数据 MetaDataClient.describeColumnPageByTableName 接口出错了"
},
"RequestId": "964be7a0-7dde-4a2f-8a53-fa60524f87f8"
}
}示例3 查询表的所有列元数据
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeColumnsMeta
<公共请求参数>
{
"TableId": "abc",
"PageNumber": 0,
"PageSize": 0,
"FilterSet": [
{
"Name": "abc",
"Values": [
"abc"
]
}
],
"OrderFieldSet": [
{
"Name": "abc",
"Direction": "abc"
}
],
"IsPartitionQuery": true,
"ComplianceId": 0
}输出示例
{
"Response": {
"ColumnMetaSet": [
{
"NameEn": "abc",
"NameCn": "abc",
"Type": "abc",
"Description": "abc",
"Position": 0,
"IsPartition": true,
"Name": "abc",
"ColumnFamiliesFieldSet": [
{
"Key": "abc",
"Value": "abc"
}
],
"DictionaryId": "abc",
"DictionaryName": "abc",
"LevelName": "abc",
"LevelRank": 0
}
],
"TotalCount": 0,
"RequestId": "abc"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.SignatureExpire | 未登录或登录已过期。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| ResourceNotFound | 资源不存在。 |
