1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
获取表元数据list
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTableMetas。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| PageNumber | 否 | Integer | 分页页码 示例值：1 |
| PageSize | 否 | Integer | 分页大小 示例值：10 |
| Filters.N | 否 | Array of Filter | 过滤字段: dbName-数据库名称 bizCatalogIds-资产目录ID DataLayerUuid-数仓分层ID ownerAccount-负责人ID assetStatus-资产状态：1-已上架 0-未上架 assetLevel-资产等级：40-核心30-重要 20-一般 10-临时 msTypes-数据源类型：例如TENCENT_MYSQL-腾讯云MySQL，数据源类型ID可参考 [ { "DisplayName": "TCHouse-P", "Id": "TCHOUSE_P" }, { "DisplayName": "Iceberg", "Id": "ICEBERG" }, { "DisplayName": "Hive", "Id": "HIVE" }, { "DisplayName": "HBase", "Id": "HBASE" }, { "DisplayName": "DLC", "Id": "DLC" }, { "DisplayName": "腾讯云MySQL", "Id": "TENCENT_MYSQL" }, { "DisplayName": "TCHouse-D", "Id": "TCHOUSE_D" }, { "DisplayName": "TCHouse-C", "Id": "TCHOUSE_C" }, { "DisplayName": "EMR StarRocks", "Id": "EMR_STARROCKS" }, { "DisplayName": "Doris", "Id": "DORIS" }, { "DisplayName": "MySQL", "Id": "MYSQL" }, { "DisplayName": "Oracle", "Id": "ORACLE" }, { "DisplayName": "PostgreSQL", "Id": "POSTGRE" }, { "DisplayName": "SQL Server", "Id": "SQLSERVER" }, { "DisplayName": "TDSQL PostgreSQL", "Id": "TDSQL_POSTGRE" }, { "DisplayName": "Greenplum", "Id": "GREENPLUM" }, { "DisplayName": "StarRocks", "Id": "STARROCKS" }, { "DisplayName": "ClickHouse", "Id": "CLICKHOUSE" }, { "DisplayName": "INFLUXDB", "Id": "INFLUXDB" }, { "DisplayName": "达梦DM", "Id": "DM" }, { "DisplayName": "OceanBase", "Id": "OCEANBASE" }, { "DisplayName": "TDSQL MySQL", "Id": "TDSQL_MYSQL" }, { "DisplayName": "GaussDB", "Id": "GAUSSDB" } ] projectIds-归属项目ID keyword-关键字，支持表名/表中文名/数据库名 |
| OrderFields.N | 否 | Array of OrderField | 排序字段 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TableMetas | Array of TableMeta | 表元数据 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalCount | Integer | 总条数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取表元数据list
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTableMetas
<公共请求参数>
{
"PageNumber": 1,
"PageSize": 10,
"Filters": [
{
"Name": "keywordType",
"Values": [
"table"
]
},
{
"Name": "msTypes",
"Values": [
"HIVE",
"HBASE"
]
},
{
"Name": "keyword",
"Values": [
"t210011"
]
}
],
"OrderFields": [
{
"Name": "heatValue",
"Direction": "ASC"
}
]
}输出示例
{
"Response": {
"TableMetas": [
{
"ClusterId": null,
"TableHeat": {
"Heat": 0,
"MaxHeat": 0,
"TableId": "100011eKq1NfbRTkGIhfK_Q",
"DayTime": "2020-09-22T00:00:00+00:00"
},
"DatabaseId": "12tAIQcu10001_jg",
"HasFavorite": true,
"ProjectDisplayName": "dev-proj",
"StorageSizeWithUnit": "839B",
"TableId": "100011eKq1NfbRTkGIhfK_Q",
"BizCatalogNames": [],
"TablePath": null,
"LikeCount": 0,
"TableNameCn": null,
"DdlModifyTime": "2020-09-22T00:00:00+00:00",
"Description": null,
"InstanceId": null,
"TableName": "t2",
"LastAccessTime": "2020-09-22T00:00:00+00:00",
"LifeCycleTime": 0,
"MetastoreId": 0,
"DataModifyTime": "2020-09-22T00:00:00+00:00",
"TablePropertyScore": {
"Timeliness": 0,
"Average": 0,
"DayTime": "2020-09-22T00:00:00+00:00",
"Normative": 0,
"Stability": 0,
"TableId": "100011eKq1NfbRTkGIhfK_Q",
"Safety": 0,
"Integrity": 0
},
"Partitions": null,
"ReplicationFactor": null,
"DatasourceName": "hive_emr-db",
"StorageFormat": null,
"TechnologyType": null,
"ProjectId": "1840468646888110001",
"BizCatalogIds": [],
"ColumnSeparator": null,
"DataSourceCategory": null,
"Columns": [
{
"ChineseName": null,
"ColumnKey": null,
"Description": null,
"IsPartition": false,
"Name": "id",
"Position": 0,
"Type": "BIGINT",
"CreateTime": "2024-01-04T05:51:19.000+00:00",
"DefaultValue": null,
"Length": null,
"ModifiedTime": "2024-01-04T05:51:19.000+00:00",
"Precision": null,
"Scale": null
}
],
"DatasourceId": 0,
"HasAdminAuthority": true,
"TableOwnerName": "owner-name",
"ModifyTime": "2020-09-22T00:00:00+00:00",
"TableNameEn": "t2",
"FavoriteCount": 0,
"TableType": null,
"DatasourceDisplayName": "hive_emr-bb",
"ClusterName": null,
"ProjectName": null,
"HasLike": true,
"MetastoreType": "HIVE",
"DatabaseName": "database-name",
"StorageSize": 0,
"CreateTime": "2020-09-22T00:00:00+00:00",
"TableOwnerId": "owner-id",
"OwnerProjectId": "project-id"
}
],
"TotalCount": 10,
"RequestId": "91300e24-4685-4f08-8870-b46ad2fad146"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
