tencent cloud



Last updated: 2022-08-17 15:58:23

1. API Description

Domain name for API request: cdb.tencentcloudapi.com.

This API is used to upgrade the configuration of database proxy.

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: UpgradeCDBProxy.
Version Yes String Common Params. The value used for this API: 2017-03-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID
ProxyGroupId Yes String Database proxy ID
ProxyCount Yes Integer Number of proxy nodes
Cpu Yes Integer Number of CPU cores per proxy node
Mem Yes Integer Memory per proxy node
ReloadBalance Yes String Load rebalance mode. Valid values: auto, manual
UpgradeTime Yes String Upgrade time. Valid values: nowTime (upgrade immediately), timeWindow (upgrade during instance maintenance time)

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Async request ID
Note: this field may return null, indicating that no valid value can be found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Upgrading the configuration of database proxy

Input Example

Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeCDBProxy
<Common request parameters>

    "UpgradeTime": "nowTime",
    "ProxyGroupId": "proxy-test",
    "InstanceId": "cdb-test",
    "Mem": 4000,
    "ReloadBalance": "true",
    "Cpu": 2,
    "ProxyCount": 4

Output Example

    "Response": {
        "AsyncRequestId": "8155d27a-079a2580-19593e48-f1af5042",
        "RequestId": "3689c0eb-a92d-77ce-0ee2-17d99f604e64"

5. Developer Resources


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

Command Line Interface

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.SubmitAsyncTaskError Failed to submit the task. Please try again later. If the submission remains unsuccessful, please contact customer service.
InternalError.UnknownError Unknown error
OperationDenied.ProxyUpgradeTaskStatusError This operation is not allowed during database proxy upgrade task.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support