云数据库 PostgreSQL 查询PostgREST服务信息详

1. 接口描述

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

本接口（DescribePostgRestService）用于查询某个实例的PostgREST服务信息

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribePostgRESTService。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
DBInstanceId	是	String	实例ID 参数格式：postgres-19nmz2xb 示例值：postgres-0uwjmh8t

3. 输出参数

参数名称	类型	描述
Status	String	PostgREST服务运行状态枚举值： closed：已关闭 creating：创建中 running：运行中默认值：closed 示例值：running
CreateTime	String	创建时间参数格式：2026-05-10 10:00:00 示例值：2026-05-11 15:15:50
NetworkAccessList	Array of DBInstanceNetInfo	PostgREST服务网络连接信息注意：此字段可能返回 null，表示取不到有效值。
JWTSecret	String	PostgREST服务JWT值注意：此字段可能返回 null，表示取不到有效值。示例值：dsfadlsfjkadsjfalkdfjads
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询PostgREST服务详情信息

输入示例

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

{
    "DBInstanceId": "postgres-0uwjmh8t"
}

输出示例

{
    "Response": {
        "CreateTime": "2026-05-11 15:15:50",
        "JWTSecret": "dsfadlsfjkadsjfalkdfjads",
        "NetworkAccessList": [
            {
                "Address": "",
                "Ip": "10.0.0.7",
                "NetType": "private",
                "Port": 3000,
                "ProtocolType": "postgrest",
                "Status": "opened",
                "SubnetId": "subnet-3hekhnki",
                "VpcId": "vpc-a27ykb0r"
            }
        ],
        "Status": "running",
        "RequestId": "2066fe70-ca9d-4b1d-8c6d-76ac834251cf"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure.UnauthorizedOperation	鉴权失败。
InvalidParameterValue.IllegalRegion	非法的Region参数。
InvalidParameterValue.IllegalZone	非法的Zone参数。
InvalidParameterValue.InstanceNotExist	当前实例不存在。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
OperationDenied.CamDeniedError	当前操作被限制。
ResourceNotFound.InstanceNotFoundError	实例不存在。

查询PostgREST服务信息详情

本页目录：