查询数据库对象列表

1. 接口描述

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

本接口用于查询数据库对象列表。例如查询test数据库下的模式列表。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查询对象为database

查询数据库列表

输入示例

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

{
    "DBInstanceId": "postgres-5cz25tr5",
    "ObjectType": "database"
}

输出示例

{
    "Response": {
        "ObjectSet": [
            "postgres",
            "postgres_bak_1715170243",
            "user_database"
        ],
        "TotalCount": 3,
        "RequestId": "c90f7a9d-f519-4d2f-bb2f-e3966cd102b6"
    }
}

示例2 查询对象为schema

查询user_database下的模式

输入示例

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

{
    "DBInstanceId": "postgres-5cz25tr5",
    "ObjectType": "schema",
    "Limit": 2,
    "Offset": 1,
    "DatabaseName": "user_database"
}

输出示例

{
    "Response": {
        "ObjectSet": [
            "information_schema",
            "pg_catalog"
        ],
        "TotalCount": 2,
        "RequestId": "bb6146b9-0c63-40ea-b89a-d83944805b79"
    }
}

示例3 查询对象为table

查询user_database数据库下，属于user_schema模式的表

输入示例

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

{
    "DBInstanceId": "postgres-5cz25tr5",
    "ObjectType": "table",
    "DatabaseName": "user_database",
    "SchemaName": "user_schema"
}

输出示例

{
    "Response": {
        "ObjectSet": [
            "users",
            "users1",
            "users2"
        ],
        "TotalCount": 3,
        "RequestId": "80530420-d73e-4a60-8149-93cf800220b9"
    }
}

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

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