CreateTCPListeners
Last updated: 2020-04-17 15:10:18
1. API Description
Domain name for API request: gaap.tencentcloudapi.com.
This API (CreateTCPListeners) is used to batch create TCP listeners of single connections or connection groups.
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: CreateTCPListeners. |
| 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. |
| ListenerName | Yes | String | Listener name. |
| Ports.N | Yes | Array of Integer | List of listener ports. |
| Scheduler | Yes | String | Origin server scheduling policy of listeners, which supports round robin (rr), weighted round robin (wrr), and least connections (lc). |
| HealthCheck | Yes | Integer | Whether origin server has the health check enabled. 1: enabled; 0: disabled. UDP listeners do not support health check. |
| RealServerType | Yes | String | The origin server type of listeners, supporting IP or DOMAIN type. The DOMAIN origin servers do not support the weighted round robin. |
| ProxyId | No | String | Connection ID; Either ProxyId or GroupId must be set, but you cannot set both. |
| GroupId | No | String | Connection group ID; Either ProxyId or GroupId must be set, but you cannot set both. |
| 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. |
| RealServerPorts.N | No | Array of Integer | List of origin server ports, which only supports the listeners of version 1.0 and connection group. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| ListenerIds | Array of String | Returns the listener ID |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Creating a TCP Listener
Create a TCP listener.
Input Example
https://gaap.tencentcloudapi.com/?Action=CreateTCPListeners
&ProxyId=link-bjkpdum1
&ListenerName=test1
&RealServerType=IP
&Scheduler=rr
&DelayLoop=20
&ConnectTimeout=20
&HealthCheck=1
&Ports.0=90
&<Common request parameters>Output Example
{
"Response": {
"RequestId": "9aeda369-17c7-429f-be39-745c1e92fc71",
"ListenerIds": [
"listener-o0f3at99"
]
}
}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.
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
Command Line Interface
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.DuplicatedRequest | Repeated request. Please check the value of ClientToken. |
| FailedOperation.GroupStatusNotInRuning | Unable to operate: the connection group is not running. |
| FailedOperation.InstanceStatusNotInRuning | Unable to operate: the connection is not running. |
| FailedOperation.LimitNumofListener | Limit on the number of listeners exceeded. |
| FailedOperation.ProxyStatusNotInRuning | Unable to add listeners: the connection is not running. |
| InternalError | Internal error |
| InvalidParameter | Parameter error |
| InvalidParameterValue | Parameter value error |
| InvalidParameterValue.DuplicatedListenerPort | Listener port already exists. |
| InvalidParameterValue.InvalidListenerPort | The listener port is not available. |
| MissingParameter | Parameter missing |
| ResourceNotFound | Resource does not exist |
| ResourceUnavailable | Resource is unavailable |
