查询实例的数据库列表

1. 接口描述

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

接口（DescribeDatabases）用来查询实例的数据库列表。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 获取实例所有数据库

不做筛选，全量拉取实例的数据库列表。

输入示例

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

{
    "DBInstanceId": "postgres-hf8jo5pr"
}

输出示例

{
    "Response": {
        "Items": [
            "postgres",
            "postgres_bak_1715086333",
            "postgres_bak_1715140150",
            "rds",
            "postgres_bak_1715152994"
        ],
        "Databases": [
            {
                "DatabaseName": "postgres",
                "DatabaseOwner": "postgres",
                "Encoding": "UTF8",
                "Collate": "C",
                "Ctype": "C",
                "AllowConn": true,
                "ConnLimit": -1,
                "Privileges": "=Tc/postgres,postgres=CTc/postgres,pg_tencentdb_superuser=C/postgres"
            },
            {
                "DatabaseName": "postgres_bak_1715086333",
                "DatabaseOwner": "postgres",
                "Encoding": "UTF8",
                "Collate": "C",
                "Ctype": "C",
                "AllowConn": true,
                "ConnLimit": -1,
                "Privileges": ""
            },
            {
                "DatabaseName": "postgres_bak_1715140150",
                "DatabaseOwner": "postgres",
                "Encoding": "UTF8",
                "Collate": "C",
                "Ctype": "C",
                "AllowConn": true,
                "ConnLimit": -1,
                "Privileges": ""
            },
            {
                "DatabaseName": "rds",
                "DatabaseOwner": "postgres",
                "Encoding": "UTF8",
                "Collate": "C",
                "Ctype": "C",
                "AllowConn": true,
                "ConnLimit": -1,
                "Privileges": ""
            },
            {
                "DatabaseName": "postgres_bak_1715152994",
                "DatabaseOwner": "postgres",
                "Encoding": "UTF8",
                "Collate": "C",
                "Ctype": "C",
                "AllowConn": true,
                "ConnLimit": -1,
                "Privileges": ""
            }
        ],
        "RequestId": "4045d7a9-5330-4c2c-b968-475570200a97",
        "TotalCount": 5
    }
}

示例2 获取实例部分数据库

使用筛选条件，返回部分数据库列表。

输入示例

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

{
    "DBInstanceId": "postgres-hf8jo5pr",
    "Filters": [
        {
            "Name": "database-name",
            "Values": [
                "postgres"
            ]
        }
    ],
    "Offset": 1,
    "Limit": 2
}

输出示例

{
    "Response": {
        "Items": [
            "postgres_bak_1715086333",
            "postgres_bak_1715140150"
        ],
        "Databases": [
            {
                "DatabaseName": "postgres_bak_1715086333",
                "DatabaseOwner": "postgres",
                "Encoding": "UTF8",
                "Collate": "C",
                "Ctype": "C",
                "AllowConn": true,
                "ConnLimit": -1,
                "Privileges": ""
            },
            {
                "DatabaseName": "postgres_bak_1715140150",
                "DatabaseOwner": "postgres",
                "Encoding": "UTF8",
                "Collate": "C",
                "Ctype": "C",
                "AllowConn": true,
                "ConnLimit": -1,
                "Privileges": ""
            }
        ],
        "RequestId": "25cc2555-14a2-454f-af08-6bd691315335",
        "TotalCount": 5
    }
}

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. 错误码

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