1. 接口描述
接口请求域名： tcaplusdb.tencentcloudapi.com 。
查询表详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTables。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterId | 否 | String | 待查询表格所属集群ID 示例值：5674209986 |
| TableGroupIds.N | 否 | Array of String | 待查询表格所属表格组ID列表 示例值：1 |
| SelectedTables.N | 否 | Array of SelectedTableInfoNew | 待查询表格信息列表，用户不用关注，过滤请使用filter |
| Filters.N | 否 | Array of Filter | 过滤条件，本接口支持：TableName，TableInstanceId |
| Offset | 否 | Integer | 查询结果偏移量 示例值：1 |
| Limit | 否 | Integer | 查询结果返回记录数量 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 表格数量 示例值：1 |
| TableInfos | Array of TableInfoNew | 表格详情结果列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询表列表
查询表列表
输入示例
https://tcaplusdb.tencentcloudapi.com/?Action=DescribeTables
&ClusterId=5674209986
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 1,
"TableInfos": [
{
"TableName": "abc",
"TableInstanceId": "abc",
"TableType": "abc",
"TableIdlType": "abc",
"ClusterId": "abc",
"ClusterName": "abc",
"TableGroupId": "abc",
"TableGroupName": "abc",
"KeyStruct": "abc",
"ValueStruct": "abc",
"ShardingKeySet": "abc",
"IndexStruct": "abc",
"ListElementNum": 1,
"IdlFiles": [
{
"FileName": "abc",
"FileType": "abc",
"FileExtType": "abc",
"FileSize": 0,
"FileId": 0,
"FileContent": "abc"
}
],
"ReservedVolume": 0,
"ReservedReadQps": 0,
"ReservedWriteQps": 0,
"TableSize": 0,
"Status": "abc",
"CreatedTime": "abc",
"UpdatedTime": "abc",
"Memo": "abc",
"Error": {
"Code": "abc",
"Message": "abc"
},
"ApiAccessId": "abc",
"SortFieldNum": 0,
"SortRule": 0,
"DbClusterInfoStruct": "abc",
"TxhBackupExpireDay": 1,
"SyncTableInfo": {
"TargetTableSplitNum": 1,
"TargetTableNamePrefix": [
"abc"
],
"TargetSyncDBInstanceId": "abc",
"TargetDatabaseName": "abc",
"Status": 0,
"ClusterId": "abc",
"TableGroupId": 1,
"TableName": "abc",
"TableId": "abc",
"KeyFieldMapping": [
{
"SourceName": "abc",
"TargetName": "abc"
}
],
"ValueFieldMapping": [
{
"SourceName": "abc",
"TargetName": "abc"
}
]
}
}
],
"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.UnauthorizedOperation | 接口操作鉴权错误。 |
| FailedOperation | 操作失败。 |
| FailedOperation.RegionMismatch | 请求的地域不匹配。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |