1. 接口描述
接口请求域名： postgres.tencentcloudapi.com 。
本接口（ModifyDBProxySSLConfig）用于修改数据库代理连接地址的 SSL 配置。该接口为异步接口，调用成功后返回 TaskId，可通过 DescribeTasks 接口查询任务执行进度。
当前仅支持物理机（local）存储类型的代理开启 SSL。SSL 开启时需提供 ConnectAddress，且必须与代理地址的 Vip 保持一致。
当 SSL 状态与当前配置一致时，接口直接返回成功，TaskId 为 0，无需等待任务。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyDBProxySSLConfig。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DBInstanceId | 是 | String | 实例 ID，指定要修改 SSL 配置的数据库代理所属的目标实例 示例值：postgres-xxxxxxxx |
| ProxyGroupId | 是 | String | 代理组 ID，指定要修改 SSL 配置的代理组 示例值：proxygrp-xxxxxxxx |
| ProxyAddressId | 是 | String | 代理地址 ID，指定要修改 SSL 配置的代理连接地址 示例值：proxyaddr-xxxxxxxx |
| SSLEnabled | 是 | Boolean | SSL 开关。true：开启 SSL；false：关闭 SSL 示例值：true |
| ConnectAddress | 否 | String | 连接地址。SSLEnabled 为 true 时必填，需与代理地址的 Vip 保持一致，用于 SSL 证书校验 示例值：10.0.0.1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | Integer | 异步任务 ID。可通过 DescribeTasks 接口查询任务执行进度。当 SSL 状态无变更时返回 0，无需等待任务 示例值：12 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 开启代理 SSL
为指定代理连接地址开启 SSL，需传入与代理地址 Vip 一致的 ConnectAddress
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBProxySSLConfig
<公共请求参数>
{
"DBInstanceId": "postgres-xxxxxxxx",
"ProxyGroupId": "proxygrp-xxxxxxxx",
"ProxyAddressId": "proxyaddr-xxxxxxxx",
"SSLEnabled": true,
"ConnectAddress": "10.0.0.1"
}输出示例
{
"Response": {
"RequestId": "ba9bf5a6-907a-43de-b81b-41c7430c1f6c",
"TaskId": "12"
}
}示例2 关闭代理 SSL
关闭指定代理连接地址的 SSL，无需传 ConnectAddress
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBProxySSLConfig
<公共请求参数>
{
"DBInstanceId": "postgres-xxxxxxxx",
"ProxyGroupId": "proxygrp-xxxxxxxx",
"ProxyAddressId": "proxyaddr-xxxxxxxx",
"SSLEnabled": false
}输出示例
{
"Response": {
"RequestId": "ba9bf5a6-907a-43de-b81b-41c7430c1f6c",
"TaskId": "13"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.FailedOperationError | 操作失败，请稍后重试。 |
| FailedOperation.FlowCreateError | 创建流程失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| InvalidParameter.ParameterCheckError | 参数检查失败。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
| OperationDenied.InstanceStatusLimitError | 实例当前状态限制本次操作。 |
| OperationDenied.InstanceStatusLimitOpError | 实例状态限制当前操作。 |
| ResourceNotFound.InstanceNotFoundError | 实例不存在。 |
