1. 接口描述
接口请求域名： cynosdb.tencentcloudapi.com 。
本接口（UpgradeProxy）用于升级数据库代理配置。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpgradeProxy。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-07。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。 |
| ClusterId | 是 | String | 集群ID 示例值：cynosdbmysql-mwg7121e |
| Cpu | 是 | Integer | cpu核数 示例值：2 |
| Mem | 是 | Integer | 内存 示例值：4000 |
| ProxyCount | 否 | Integer | 数据库代理组节点个数 示例值：2 |
| ProxyGroupId | 否 | String | 数据库代理组ID（已废弃） 示例值：cynosdbmysql-proxy-mwg7121e |
| ReloadBalance | 否 | String | 重新负载均衡：auto（自动），manual（手动） 示例值：manual |
| IsInMaintainPeriod | 否 | String | 升级时间 ：no（升级完成时）yes（实例维护时间） 示例值：no |
| ProxyZones.N | 否 | Array of ProxyZone | 数据库代理节点信息 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FlowId | Integer | 异步流程ID 示例值：27342 |
| TaskId | Integer | 异步任务ID 示例值：12878 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 升级数据库代理配置
升级数据库代理配置
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeProxy
<公共请求参数>
{
"ClusterId": "cynosdbmysql-dnofdr2d",
"ProxyCount": 2,
"Cpu": 2,
"Mem": 4,
"ProxyGroupId": "cynosdbmysql-proxy-4378e0kb",
"ReloadBalance": "auto",
"IsInMaintainPeriod": "no",
"ProxyZones": [
{
"ProxyNodeZone": "ap-guangzhou-3",
"ProxyNodeCount": 2
}
]
}输出示例
{
"Response": {
"FlowId": 127635,
"TaskId": 174673,
"RequestId": "a5706353-296a-4992-ad07-ac4a48eeba43"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.DatabaseAccessError | 数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.FlowCreateError | 创建流程失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.OperationFailedError | 操作失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.SpecNotFoundError | 规格信息{{1}}搜索失败 |
| OperationDenied.GetProxyGroupFailedError | 获取proxy失败 |
| OperationDenied.ProxyConnectCountCheckError | proxy节点支持的可创建的连接数量不匹配,可支持的创建连接数{{1}},当前连接数{{2}} |
| OperationDenied.ProxyNodeCountCheckError | 代理节点数量检查失败 |
| OperationDenied.ProxyNotRunningError | 非运行的proxy |
| OperationDenied.ProxySaleZoneCheckError | 可用区不存在 |
| OperationDenied.ProxyVersionCheckError | 代理版本检查失败 |
| OperationDenied.ProxyZoneCheckError | proxy可用区校验失败 |
| UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |
