Domain name for API request: gaap.tencentcloudapi.com.
This API (ModifyTCPListenerAttribute) is used to modify the TCP listener configuration of a connection instance, including health check configuration and scheduling policies.
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: ModifyTCPListenerAttribute. |
Version | Yes | String | Common Params. The value used for this API: 2018-05-29. |
Region | No | String | Common Params. This parameter is not required. |
ListenerId | Yes | String | Listener ID |
GroupId | No | String | Connection group ID; Either ProxyId or GroupId must be set, but you cannot set both. |
ProxyId | No | String | Connection ID; Either ProxyId or GroupId must be set, but you cannot set both. |
ListenerName | No | String | Listener name |
Scheduler | No | String | The strategy used by the listener to access the origin server. Values: rr (round-robin), wrr (weighted round-robin), lc (the least-connections strategy), lrtt (the least-response-time strategy). |
DelayLoop | No | Integer | Time interval of origin server health check (unit: seconds). Value range: [5, 300]. |
ConnectTimeout | No | Integer | Response timeout of origin server health check (unit: seconds). Value range: [2, 60]. The timeout value shall be less than the time interval for health check DelayLoop. |
HealthCheck | No | Integer | Whether to enable health check. 1: enable; 0: disable. |
FailoverSwitch | No | Integer | Whether to enable the primary/secondary origin server mode. Valid values: 1 (enable) and 0 (disable). It cannot be enabled for domain name origin servers. |
HealthyThreshold | No | Integer | Healthy threshold. The number of consecutive successful health checks required before considering an origin server healthy. Value range: 1 - 10. |
UnhealthyThreshold | No | Integer | Unhealthy threshold. The number of consecutive failed health checks required before considering an origin server unhealthy. Value range: 1 -10. |
Parameter Name | Type | Description |
---|---|---|
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 modify the TCP listener configuration.
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTCPListenerAttribute
<Common request parameters>
{
"ConnectTimeout": "20",
"ProxyId": "link-bjkpdum1",
"HealthCheck": "1",
"ListenerId": "listener-o0f3at99",
"ListenerName": "test10",
"Scheduler": "rr",
"DelayLoop": "30"
}
{
"Response": {
"RequestId": "3919ba30-85c4-4cb4-81bf-ff243b50f3dc"
}
}
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 |
---|---|
AuthFailure | CAM signature/authentication error. |
AuthFailure.NotEnterpriseAuthorization | Not an organizational customer. |
AuthFailure.UnauthorizedOperation | The sub-account is not authorized for this operation. |
FailedOperation | Operation failed. |
FailedOperation.GroupStatusNotInRuning | Unable to operate: the connection group is not running. |
FailedOperation.InstanceStatusNotInRuning | Unable to operate: the connection is not running. |
FailedOperation.ListenerHasTask | The listener is in operation. Do not repeat the operation. |
FailedOperation.ListenerStatusError | The listener does not support this operation in current status. |
FailedOperation.NonStandardProxy | This connection is non-standard and write operations are not allowed. |
FailedOperation.UserNotConfirmProtocol | Protocol not activated. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameterValue | Incorrect parameter value. |
MissingParameter | Missing parameter. |
ResourceNotFound | The resource does not exist. |
ResourceUnavailable.AccountViolation | Restricted resources found in your account. Check your inbox and email for details. |
UnauthorizedOperation | Unauthorized operation. |
本页内容是否解决了您的问题?