UpgradeProxy

Last updated: 2025-11-13 20:51:36

UpgradeProxy

Last updated: 2025-11-13 20:51:36

1. API Description

Domain name for API request: cynosdb.intl.tencentcloudapi.com.

This API is used to upgrade database proxy configuration.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: UpgradeProxy.
Version	Yes	String	Common Params. The value used for this API: 2019-01-07.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterId	Yes	String	Cluster ID
Cpu	Yes	Integer	Number of CPU cores
Mem	Yes	Integer	Memory
ProxyCount	No	Integer	Number of nodes in the proxy group
ProxyGroupId	No	String	ID of the database proxy group (disused)
ReloadBalance	No	String	Load rebalance mode. Valid values: `auto`, `manual`
IsInMaintainPeriod	No	String	Upgrade time. Valid values: `no` (upon upgrade completion), `timeWindow` (upgrade during instance maintenance time)
ProxyZones.N	No	Array of ProxyZone	Node information of the atabase proxy

3. Output Parameters

Parameter Name	Type	Description
FlowId	Integer	Async flow ID
TaskId	Integer	Async task ID
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Upgrading Database Proxy Configuration

This example shows you how to upgrade the database proxy configuration.

Input Example

POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeProxy
<Common request parameters>

{
    "ClusterId": "cynosdbmysql-dnofdr2d",
    "ProxyCount": 2,
    "Cpu": 2,
    "Mem": 4,
    "ProxyGroupId": "cynosdbmysql-proxy-4378e0kb",
    "ReloadBalance": "auto",
    "IsInMaintainPeriod": "no",
    "ProxyZones": [
        {
            "ProxyNodeZone": "ap-guangzhou-3",
            "ProxyNodeCount": 2
        }
    ]
}

Output Example

{
    "Response": {
        "FlowId": 127635,
        "TaskId": 174673,
        "RequestId": "a5706353-296a-4992-ad07-ac4a48eeba43"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed
FailedOperation.DatabaseAccessError	Failed to access the database. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FlowCreateError	Failed to create a task. Try again later. If the problem persists, contact customer service.
FailedOperation.OperationFailedError	Operation failed. Try again later. If the problem persists, contact customer service.
FailedOperation.SpecNotFoundError	Specification information {{1}} search failure.
OperationDenied.GetProxyGroupFailedError	Fail to retrieve the proxy.
OperationDenied.ProxyConnectCountCheckError	Mismatched number of creatable connections supported by the proxy node. the supported number of create connections is {{1}}, and the current number of connections is {{2}}.
OperationDenied.ProxyNodeCountCheckError	Proxy node quantity check_failed.
OperationDenied.ProxyNotRunningError	Non-Running proxy.
OperationDenied.ProxySaleZoneCheckError	Availability zone does not exist.
OperationDenied.ProxyVersionCheckError	Proxy version check_failed.
OperationDenied.ProxyZoneCheckError	Verification failure of proxy availability zone.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud