AdjustCdbProxyAddress

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: AdjustCdbProxyAddress.
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.
ProxyGroupId	Yes	String	Proxy group ID
WeightMode	Yes	String	Assignment mode of weights. Valid values: `system` (auto-assigned), `custom`.
IsKickOut	Yes	Boolean	Whether to remove delayed read-only instances from the proxy group Valid values: `true`, `false`.
MinCount	Yes	Integer	Least read-only instances. Minimum value: `0`
MaxDelay	Yes	Integer	The delay threshold. Minimum value: `0`
FailOver	Yes	Boolean	Whether to enable failover. Valid values: `true`, `false`.
AutoAddRo	Yes	Boolean	Whether to automatically add newly created read-only instances. Valid values: `true`, `false`.
ReadOnly	Yes	Boolean	Whether it is read-only. Valid values: `true`, `false`.
ProxyAddressId	Yes	String	Address ID of the proxy group
TransSplit	No	Boolean	Whether to enable transaction splitting. Valid values: `true`, `false`.
ConnectionPool	No	Boolean	Whether to enable the connection pool
ProxyAllocation.N	No	Array of ProxyAllocation	Assignment of read/write weights If `system` is passed in for `WeightMode`, only the default weight assigned by the system will take effect.

3. Output Parameters

Parameter Name	Type	Description
AsyncRequestId	String	Async task ID Note: This field may return null, indicating that no valid values can be obtained.
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 Adjusting a database proxy address

This example shows you how to adjust a database proxy address.

Input Example

POST / HTTP/1.1Host: cdb.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: AdjustCdbProxyAddress<common request parameters>{    "ProxyGroupId": "proxy-il2nlsdn",    "ProxyAddressId": "proxy-il2nlsdn",    "IsKickOut": true,    "MinCount": 1,    "MaxDelay": 10,    "WeightMode": "custom",    "FailOver": true,    "AutoAddRo": true,    "ReadOnly": false,    "TransSplit": false,    "ConnectionPool": true,    "ProxyAllocation": [        {            "Region": "ap-guangzhou",            "Zone": "ap-guangzhou-2",            "ProxyInstance": [                {                    "InstanceId": "cdb-aykuksx3",                    "Weight": 100                }            ]        }    ]}

Output Example

{
    "Response": {
        "RequestId": "111-1314-333-2321212",
        "AsyncRequestId": "test"
    }
}

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.DescribeProxyGroupError	Failed to query database proxy.
FailedOperation.FailedOperationError	Unsupported operation
InternalError.UnknownError	Unknown error
InvalidParameter.InvalidParameterError	Invalid parameter value
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value
OperationDenied.ProxyUpgradeTaskStatusError	This operation is not allowed during database proxy upgrade task.
OperationDenied.UnsupportCreateAddressError	Creating a proxy address is not supported.
ResourceNotFound.InstanceNotFundError	The instance does not exist.

Was this page helpful?

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

Yes

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Tencent Big Model

Internet of Things

Stream Services

Cloud Real-time Rendering

Management and Audit Tools

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Developer Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Image Creation

Natural Language Processing

Communication

Media Process Services

Education Sevices

Monitor and Operation

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Voice Technology

Optical Character Recognition

Interactive Video Services

Media SDK

Cloud Resource Management

More

1. API Description