上报table元数据

最近更新时间:2025-07-28 14:16:35

我的收藏

1. 接口描述

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

上报table元数据

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ReportTable。
Version String 公共参数,本接口取值:2021-08-20。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, ap-shanghai-fsi, ap-singapore, na-siliconvalley 。
DatasourceId Integer 数据源id
示例值:123
DatabaseName String database名称,字符长度128内
示例值:default
TableName String table名称,字符长度128内
示例值:table1
Type String 表类型,VIEW/TABLE
示例值:TABLE
SchemaName String schema名称,字符长度128内
示例值:user
Description String 描述,字符长度1000内
示例值:描述
CreateTime Integer 创建时间戳,毫秒,为空默认当前时间
示例值:1750399557000
ModifiedTime Integer 修改时间戳,毫秒,为空默认当前时间
示例值:1750399557000
Columns.N Array of ReportColumnInfo 字段信息

3. 输出参数

参数名称 类型 描述
Guid String 元数据唯一id
示例值:ZxPE4RZ0cQnUCaDHz-awBw
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 上报table元数据

上报table元数据,需要先上报database和schema(如果有)
如无schema可以填空

输入示例

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

{
    "DatasourceId": 62112,
    "DatabaseName": "default",
    "TableName": "luffyshi_test3",
    "Type": "TABLE",
    "SchemaName": "default_schema",
    "Description": "test",
    "CreateTime": 1751611555000,
    "ModifiedTime": 1751611555000,
    "Columns": [
        {
            "Name": "asds",
            "Type": "string",
            "Position": 1,
            "Description": "2333",
            "CreateTime": "1751611555000",
            "ModifiedTime": "1751611555000"
        }
    ]
}

输出示例

{
    "Response": {
        "Guid": "Fuo61cKNPDivwlEwnsnUIw",
        "RequestId": "3f1b3017-113a-47a6-97f7-9097bd7667c0"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
ResourceNotFound 资源不存在。