Domain name for API request: cdb.tencentcloudapi.com.
This API is used to adjust the database proxy address.
A maximum of 20 requests can be initiated per second for this API.
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 | No | String | Common Params. This parameter is not required for this API. |
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. |
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, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to adjust a database proxy address.
POST / HTTP/1.1Host: cdb.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 } ] } ]}
{
"Response": {
"RequestId": "111-1314-333-2321212",
"AsyncRequestId": "test"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
本页内容是否解决了您的问题?