查询表元数据详情

最近更新时间:2024-06-14 03:01:30

我的收藏

1. 接口描述

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

查询表元数据详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTableMeta。
Version String 公共参数,本接口取值:2021-08-20。
Region String 公共参数,详见产品支持的 地域列表
TableId String 表唯一id
示例值:12345
TableNameFilter TableNameFilter 按名称查询的条件
TableFilterType Integer 查询条件类型0按id,1按名称,默认为0

3. 输出参数

参数名称 类型 描述
TableMeta TableMeta 表的元数据信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询表元数据详情

输入示例

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

{
    "TableId": "MvNP9ruUR4qOYfQsaabbcc"
}

输出示例

{
    "Response": {
        "RequestId": "0eeb0618-621a-4e21-a74d-68f1d183749d",
        "TableMeta": {
            "BizCatalogIds": null,
            "BizCatalogNames": null,
            "ClusterId": "emr-1cbhbbccdd",
            "ClusterName": "emr-1cbhbbccdd",
            "ColumnSeparator": "Hive默认",
            "Columns": [
                {
                    "ChineseName": null,
                    "ColumnKey": null,
                    "Description": "wwwwww",
                    "IsPartition": false,
                    "Name": "wwwww",
                    "Position": 0,
                    "Type": "tinyint",
                    "CreateTime": "2024-01-08T23:32:51.000+00:00",
                    "DefaultValue": null,
                    "Length": null,
                    "ModifiedTime": "2024-01-08T23:32:51.000+00:00",
                    "Precision": null,
                    "Scale": null
                }
            ],
            "CreateTime": "2023-07-04T16:51:54+08:00",
            "DataModifyTime": null,
            "DataSourceCategory": "CLUSTER",
            "DatabaseId": "dgz--YqoS3aWyUYjKE_QQQ",
            "DatabaseName": "test11",
            "DatasourceDisplayName": "hive_emr-1cbhqqbb.test11",
            "DatasourceId": 30111,
            "DatasourceName": "hive_emr-1cbhqqbb",
            "DdlModifyTime": "2023-07-04T16:51:54+08:00",
            "Description": null,
            "FavoriteCount": 0,
            "HasAdminAuthority": false,
            "HasFavorite": false,
            "HasLike": null,
            "InstanceId": "emr-1cbhqqbb",
            "IsPartitionTable": null,
            "IsView": false,
            "LastAccessTime": "2023-07-04T16:53:42+08:00",
            "LifeCycleTime": null,
            "LikeCount": 0,
            "Location": null,
            "MetaCrawlType": "MANAGED_TABLE",
            "MetastoreId": 128643,
            "MetastoreType": "HIVE",
            "ModifyTime": "2023-07-04T16:51:54+08:00",
            "OwnerProjectId": null,
            "PartitionColumns": null,
            "PartitionExpireDays": null,
            "Partitions": null,
            "ProjectDisplayName": "项目测试",
            "ProjectId": "1728806907743539200",
            "ProjectName": "loader_test",
            "ReplicationFactor": null,
            "StorageFormat": "TEXTFILE",
            "StorageSize": 0,
            "StorageSizeWithUnit": "0B",
            "TableHeat": {
                "DayTime": "2024-04-12T00:00:00+08:00",
                "Heat": 0,
                "MaxHeat": 0,
                "TableId": "MvNP9ruUR4qOYfQsaabbcc"
            },
            "TableId": "MvNP9ruUR4qOYfQsaabbcc",
            "TableName": "aaaa_test2",
            "TableNameCn": null,
            "TableNameEn": null,
            "TableOwnerId": null,
            "TableOwnerName": "shaopenquan",
            "TablePath": "hdfs://172.16.0.7:4007/usr/hive/warehouse/test11.db/aaaa_test2",
            "TablePropertyScore": {
                "Average": 79.5,
                "DayTime": "2024-04-12T00:00:00+08:00",
                "Integrity": 88,
                "Normative": 0,
                "Safety": 30,
                "Stability": 100,
                "TableId": "MvNP9ruUR4qOYfQsVo5dFg",
                "Timeliness": 100
            },
            "TableType": "MANAGED_TABLE",
            "TechnologyType": "HIVE"
        }
    }
}

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 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
OperationDenied.UserNotInWhitelistError 用户不在白名单。
ResourceNotFound 资源不存在。