TDSQL-C MySQL 版查询数据库列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cynosdb.tencentcloudapi.com 。

本接口（DescribeClusterDetailDatabases）用于查询数据库列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeClusterDetailDatabases。
Version	是	String	公共参数，本接口取值：2019-01-07。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。
ClusterId	是	String	集群ID 示例值：cynosdbmysql-xxxxxxx
Offset	否	Integer	偏移量，默认0 示例值：0
Limit	否	Integer	返回数量，默认20,最大100 示例值：20
DbName	否	String	数据库名称示例值：test

3. 输出参数

参数名称	类型	描述
DbInfos	Array of DbInfo	数据库信息注意：此字段可能返回 null，表示取不到有效值。示例值：[]
TotalCount	Integer	总数示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据库列表

输入示例

POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterDetailDatabases
<公共请求参数>

{
    "ClusterId": "cynosdbpg-xxxxxxx",
    "Limit": 20,
    "DbName": "test",
    "Offset": 0
}

输出示例

{
    "Response": {
        "DbInfos": [
            {
                "Status": "running",
                "UserHostPrivileges": [],
                "UpdateTime": "0001-01-01T00:00:00Z",
                "Description": "",
                "DbId": 0,
                "CharacterSet": "",
                "ClusterId": "",
                "DbName": "mysql",
                "Uin": "",
                "AppId": 0,
                "CollateRule": "",
                "CreateTime": "0001-01-01T00:00:00Z"
            }
        ],
        "TotalCount": 1,
        "RequestId": "6e094b68-0a37-11ec-97e7-525400542aa6"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.DatabaseAccessError	数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.OperationFailedError	操作失败，请稍后重试。如果持续不成功，请联系客服进行处理。
InvalidParameterValue.AccountNotExistError	实例不存在账号。
InvalidParameterValue.InvalidParameterValueError	参数值无效。
OperationDenied.InstanceStatusLimitError	实例未处于运行状态
ResourceNotFound.ClusterNotFoundError	集群不存在。
UnauthorizedOperation.PermissionDenied	CAM鉴权不通过。

查询数据库列表

本页目录：