ModifyTCPListenerAttribute
Last updated: 2019-11-25 22:40:08
Contents：
1. API Description
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.
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 parameter. The value used for this API: ModifyTCPListenerAttribute |
| Version | Yes | String | Common parameter. The value used for this API: 2018-05-29 |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| 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 | Origin server scheduling policy of listeners, which supports round robin (rr), weighted round robin (wrr), and least connections (lc). |
| 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. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Modifying the TCP Listener Configuration
Modify the TCP listener configuration.
Input Example
https://gaap.tencentcloudapi.com/?Action=ModifyTCPListenerAttribute
&ProxyId=link-bjkpdum1
&ListenerId=listener-o0f3at99
&ListenerName=test10
&Scheduler=rr
&DelayLoop=30
&ConnectTimeout=20
&HealthCheck=1
&<Common request parameters>Output Example
{
"Response": {
"RequestId": "3919ba30-85c4-4cb4-81bf-ff243b50f3dc"
}
}5. Developer Resources
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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 | 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. |
| InternalError | Internal error |
| InvalidParameter | Parameter error |
| InvalidParameterValue | Parameter value error |
| MissingParameter | Parameter missing |
| ResourceNotFound | Resource does not exist |
| UnauthorizedOperation | Unauthorized operation |
