1. 接口描述
接口请求域名： tcb.tencentcloudapi.com 。
本接口(ListTables)用于查询所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListTables。 |
| Version | 是 | String | 公共参数，本接口取值：2018-06-08。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| MgoLimit | 是 | Integer | 每页返回数量（0-1000) 示例值：10 |
| Tag | 否 | String | FlexDB实例ID 示例值：tag-123 |
| MgoOffset | 否 | Integer | 分页偏移量 示例值：0 |
| Filters.N | 否 | Array of String | 过滤标签数组，用于过滤表名，可选值如：HIDDEN、WEDA、WEDA_SYSTEM 示例值：["HIDDEN"] |
| SearchValue | 否 | String | 模糊搜索查询值 示例值：prefix |
| ShowHidden | 否 | Boolean | 是否展示隐藏表 示例值：false |
| EnvId | 否 | String | 云开发环境ID 示例值：lowcode-abc |
| MongoConnector | 否 | MongoConnector | mongo连接器信息 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Tables | Array of TableInfo | 表信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Pager | Pager | 分页信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询表
输入示例
https://tcb.tencentcloudapi.com/?Action=ListTables
&MgoOffset=0
&MgoLimit=20
&Tag=tnt-nl7hjzasw
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "4ce5365a-af8c-4859-a0dd-a4bfe1f2a3d8",
"Tables": [
{
"TableName": "aris",
"Count": 12,
"Size": 899,
"IndexCount": 1,
"IndexSize": 36864
},
{
"TableName": "test2",
"Count": 1,
"Size": 36,
"IndexCount": 1,
"IndexSize": 16384
},
{
"TableName": "test3",
"Count": 0,
"Size": 0,
"IndexCount": 1,
"IndexSize": 4096
},
{
"TableName": "test4",
"Count": 0,
"Size": 0,
"IndexCount": 1,
"IndexSize": 4096
}
],
"Pager": {
"Offset": 0,
"Limit": 20,
"Total": 4
}
}
}示例2 查询表-使用MongoDB连接器
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListTables
<公共请求参数>
{
"MgoLimit": 10,
"MgoOffset": 0,
"Tag": "mongo_conn",
"ShowHidden": false,
"EnvId": "lowcode-2gqvfid5936609f4",
"MongoConnector": {
"InstanceId": "mongo_conn",
"DatabaseName": "demo_db"
}
}输出示例
{
"Response": {
"RequestId": "ee8f0898-b446-44cd-8773-676d8758c45c",
"Pager": {
"Offset": 0,
"Limit": 10,
"Total": 2
},
"Tables": [
{
"TableName": "demo_db",
"Count": 0,
"Size": 0,
"IndexCount": 1,
"IndexSize": 4096
},
{
"TableName": "demo_users",
"Count": 0,
"Size": 0,
"IndexCount": 2,
"IndexSize": 8192
}
]
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.ListTable | FailedOperation.ListTable |
| FailedOperation.Timeout | FailedOperation.Timeout |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.NoValidConnection | LimitExceeded.NoValidConnection |
| LimitExceeded.OutOfReadRequestQuota | LimitExceeded.OutOfReadRequestQuota |
| MissingParameter | 缺少参数错误。 |
| ResourceInUse | 资源被占用。 |
| ResourceUnavailable.ResourceOverdue | 资源过期。 |
| UnauthorizedOperation | 未授权操作。 |
