Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to adjust the database proxy address configuration.
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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ProxyGroupId | Yes | String | Proxy group ID, which can be obtained through the DescribeCdbProxyInfo API. |
| WeightMode | Yes | String | Weight allocation mode, |
| IsKickOut | Yes | Boolean | Whether delay removal is enabled. Value: "true" |
| MinCount | Yes | Integer | Minimum retention quantity, minimum value: 0. |
| MaxDelay | Yes | Integer | Delay removal threshold, minimum value: 1, value ranges from 1 to 10000, integer. |
| FailOver | Yes | Boolean | Whether fault migration is enabled, value: "true" |
| AutoAddRo | Yes | Boolean | Automatically add RO. Parameter: "true" |
| ReadOnly | Yes | Boolean | Whether it is read-only. Value: "true" |
| ProxyAddressId | Yes | String | Proxy group address ID. Obtain through the DescribeCdbProxyInfo API. |
| TransSplit | No | Boolean | Whether transaction splitting is enabled. Value: "true" |
| ConnectionPool | No | Boolean | Whether the connection pool is enabled. Off by default. |
| ProxyAllocation.N | No | Array of ProxyAllocation | Read-write weight allocation. If WeightMode is passed in as system, the passed-in weight does not take effect and the default weight is assigned by the system. |
| AutoLoadBalance | No | Boolean | Whether self-adaptive load balancing is enabled. Off by default. |
| AccessMode | No | String | Access mode: nearby - proximity access, balance - balanced allocation. Default is proximity access. |
| ApNodeAsRoNode | No | Boolean | Whether to treat the libra node as an ordinary RO node |
| ApQueryToOtherNode | No | Boolean | Whether to forward to other nodes in case of a libra node fault |
| Parameter Name | Type | Description |
|---|---|---|
| AsyncRequestId | String | Asynchronous 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. |
Adjust the database proxy address
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-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": "a6040589-3b098df5-b551d9e5-81c6bfdc"
}
}
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.InstanceNotFoundError | The instance does not exist. |
フィードバック