云数据库 PostgreSQL 查询代理 SSL 配置

1. 接口描述

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

本接口用于查询指定代理连接地址的 SSL 配置信息，包括 SSL 是否开启、连接地址和 CA 证书下载地址。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBProxySSLConfig。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
DBInstanceId	是	String	实例 ID。示例值：postgres-xxxxxxxx
ProxyGroupId	是	String	代理组 ID。示例值：proxy-xxxxxxxx
ProxyAddressId	是	String	代理连接地址 ID。示例值：proxy-address-xxxxxxxx

3. 输出参数

参数名称	类型	描述
SSLEnabled	Boolean	SSL 是否开启。true 表示已开启，false 表示未开启。示例值：true
ConnectAddress	String	SSL 连接的地址（VIP 或域名）。示例值：10.0.0.1
CAUrl	String	CA 证书下载地址。仅在 SSL 开启时有值。示例值：https://example.com/ca-cert.pem
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询代理 SSL 配置

查询代理 SSL 配置成功，返回 SSL 开启状态、连接地址及 CA 证书下载链接。

输入示例

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

{
    "DBInstanceId": "postgres-xxxxxxxx",
    "ProxyGroupId": "proxy-group-xxxxxxxx",
    "ProxyAddressId": "proxy-address-xxxxxxxx"
}

输出示例

{
    "Response": {
        "SSLEnabled": true,
        "ConnectAddress": "10.0.0.1",
        "CAUrl": "https://example.com/ca-cert.pem",
        "RequestId": "ba9bf5a6-907a-43de-b81b-41c7430c1f6c"
    }
}

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

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

错误码	描述
FailedOperation.FailedOperationError	操作失败，请稍后重试。
InternalError.DatabaseAccessError	数据库访问异常，请检查连接后重试
InvalidParameter.ParameterCheckError	参数检查失败。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
OperationDenied.InstanceStatusLimitError	实例当前状态限制本次操作。
ResourceNotFound.InstanceNotFoundError	实例不存在。

查询代理 SSL 配置

本页目录：