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 | 过滤字段 |
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
<公共请求参数>
{
"OrderFields": [
{
"Direction": "xx",
"Name": "xx"
}
],
"PageNumber": 0,
"Filters": [
{
"Values": [
""
],
"Name": "xx"
}
],
"PageSize": 0
}
输出示例
{
"Response": {
"TableMetas": [
{
"ClusterId": "xx",
"TableHeat": {
"Heat": 0.0,
"TableId": "xx",
"DayTime": "2020-09-22T00:00:00+00:00"
},
"DatabaseId": "xx",
"HasFavorite": true,
"ProjectDisplayName": "xx",
"StorageSizeWithUnit": "xx",
"TableId": "xx",
"BizCatalogNames": [
"xx"
],
"TablePath": "xx",
"LikeCount": 0,
"TableNameCn": "xx",
"DdlModifyTime": "2020-09-22T00:00:00+00:00",
"Description": "xx",
"InstanceId": "xx",
"TableName": "xx",
"LastAccessTime": "2020-09-22T00:00:00+00:00",
"LifeCycleTime": 0,
"MetastoreId": 0,
"DataModifyTime": "2020-09-22T00:00:00+00:00",
"TablePropertyScore": {
"Timeliness": 0.0,
"Average": 0.0,
"DayTime": "2020-09-22T00:00:00+00:00",
"Normative": 0.0,
"Stability": 0.0,
"TableId": "xx",
"Safety": 0.0,
"Integrity": 0.0
},
"Partitions": "xx",
"ReplicationFactor": "xx",
"DatasourceName": "xx",
"StorageFormat": "xx",
"TechnologyType": "xx",
"ProjectId": "xx",
"BizCatalogIds": [
"xx"
],
"ColumnSeparator": "xx",
"DatasourceId": 0,
"HasAdminAuthority": true,
"TableOwnerName": "xx",
"ModifyTime": "2020-09-22T00:00:00+00:00",
"TableNameEn": "xx",
"FavoriteCount": 0,
"TableType": "xx",
"DatasourceDisplayName": "xx",
"ClusterName": "xx",
"ProjectName": "xx",
"HasLike": true,
"MetastoreType": "xx",
"DatabaseName": "xx",
"StorageSize": 0,
"CreateTime": "2020-09-22T00:00:00+00:00"
}
],
"TotalCount": 0,
"RequestId": "xx"
}
}
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 | 操作失败。 |