1. 接口描述
接口请求域名： tdmysql.tencentcloudapi.com 。
冗余接口，无人调用
本接口（DescribeDatabaseTable）用于查询云数据库实例的表信息。
默认接口请求频率限制：20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDatabaseTable。 |
| Version | 是 | String | 公共参数，本接口取值：2021-11-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai 。 |
| InstanceId | 是 | String | 实例 ID，形如：tdsql3-ow7t8lmc。 示例值：tdsql3-52s53yyh |
| DbName | 是 | String | 数据库名称，通过 DescribeDatabases 接口获取。 示例值：test |
| Table | 是 | String | 表名称，通过 DescribeDatabaseObjects 接口获取。 示例值：persons |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例名称。 示例值：tdsql3-52s53yyh |
| DbName | String | 数据库名称。 示例值：test |
| Table | String | 表名称。 注意：此字段可能返回 null，表示取不到有效值。 示例值：persons |
| Cols | Array of TableColumn | 列信息。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 1
输入示例
POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatabaseTable
<公共请求参数>
{
"InstanceId": "tdsql3-01d1c3ed",
"Table": "user",
"DbName": "my-db"
}输出示例
{
"Response": {
"Cols": [
{
"Col": "Host",
"Type": "char(60)"
}
],
"DbName": "mysql",
"InstanceId": "tdsql3-01d1c3ed",
"RequestId": "d70d9f4e-80d8-459f-8771-73e87bd553c1",
"Table": "user"
}
}示例2 11
输入示例
POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatabaseTable
<公共请求参数>
{
"InstanceId": "tdsql3-2123sasd",
"Table": "dasf",
"DbName": "adsf"
}输出示例
{
"Response": {
"Cols": null,
"DbName": "",
"InstanceId": "",
"RequestId": "5cdd7082-d8b9-4e4c-87ea-aabe45c91b3e",
"Table": ""
}
}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.QueryDBError | 查询数据库错误。 |
