1. 接口描述
接口请求域名： tdmysql.tencentcloudapi.com 。
本接口（DescribeDatabases）用于查询云数据库实例的数据库列表。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDatabases。 |
| Version | 是 | String | 公共参数，本接口取值：2021-11-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例 ID，形如：tdsql3-ow7t8lmc。 示例值：tdsql3-42f40429 |
| Offset | 否 | Integer | 分页索引 示例值：0 |
| Limit | 否 | Integer | 每页数量 示例值：20 |
| DatabaseRegexp | 否 | String | 数据库名称匹配表达式 示例值：tpc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 透传实例ID 示例值：tdsql3-42f40429 |
| Databases | Array of Database | 该实例上的数据库列表。 |
| TotalCount | Integer | 总数量 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 1
输入示例
POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatabases
<公共请求参数>
{
"InstanceId": "“tdsql3-01d1c3ed”"
}输出示例
{
"Response": {
"Databases": [
{
"DbName": "mysql"
}
],
"InstanceId": "tdsql3-01d1c3ed",
"RequestId": "9b5e5e4a-30f2-46f8-91ee-788495d1e21f"
}
}示例2 123
输入示例
POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatabases
<公共请求参数>
{
"InstanceId": "tdsql3-jko12hds"
}输出示例
{
"Response": {
"Databases": [],
"InstanceId": "tdsql3-jko12hds",
"RequestId": "2efb7186-2e29-46d1-9bc7-05dc2b8240bf"
}
}示例3 查询云数据库实例上的数据库列表
输入示例
POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatabases
<公共请求参数>
{
"InstanceId": "tdsql3-5baee8df"
}输出示例
{
"Response": {
"Databases": [
{
"DbName": "information_schema"
},
{
"DbName": "mysql"
},
{
"DbName": "performance_schema"
},
{
"DbName": "sys"
}
],
"InstanceId": "tdsql3-42f40429 ",
"RequestId": "545457454fdasda"
}
}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.DBQueryInstanceError | 查询实例数据失败。 |
| FailedOperation.QueryDBError | 查询数据库错误。 |
