tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Global Application Acceleration Platform
    Documentation
    Download PDF

    CreateTCPListeners

    Last updated: 2023-07-13 15:25:33
    Download PDF

    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.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    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 Params. The value used for this API: CreateTCPListeners.
    Version Yes String Common Params. The value used for this API: 2018-05-29.
    Region No String Common Params. This parameter is not required.
    ListenerName Yes String Listener name.
    Ports.N Yes Array of Integer List of listener ports.
    Scheduler Yes 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).
    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. Values: IP (IP address); DOMAIN (domain name).
    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.
    ClientIPMethod No Integer Listener methods of getting client IPs. 0: TOA; 1: Proxy Protocol.
    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.

    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 TCP listeners

    This example shows you how to create a TCP listener.

    Input Example

    POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTCPListeners
<Common request parameters>

{
    "RealServerType": "IP",
    "ConnectTimeout": "20",
    "ProxyId": "link-bjkpdum1",
    "HealthCheck": "1",
    "ListenerName": "test1",
    "Scheduler": "rr",
    "Ports": [
        "90"
    ],
    "DelayLoop": "20"
}

    Output Example

    {
    "Response": {
        "RequestId": "9aeda369-17c7-429f-be39-745c1e92fc71",
        "ListenerIds": [
            "listener-o0f3at99"
        ]
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    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
    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.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.ListenerHasTask The listener is in operation. Do not repeat the operation.
    FailedOperation.NonStandardProxy This connection is non-standard and write operations are not allowed.
    FailedOperation.OperateLimitNumofListener Limit on the number of ports for a single operation exceeded.
    FailedOperation.ProxyStatusNotInRuning Unable to add listeners: the connection is not running.
    FailedOperation.ResourceUpgrading The resource is being upgraded.
    FailedOperation.UserNotConfirmProtocol Protocol not activated.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.DuplicatedListenerPort Listener port already exists.
    InvalidParameterValue.InvalidListenerPort The listener port is not available.
    MissingParameter Missing parameter.
    ResourceNotFound The resource does not exist.
    ResourceUnavailable The resource is unavailable.
    ResourceUnavailable.AccountViolation Restricted resources found in your account. Check your inbox and email for details.
    UnsupportedOperation Unsupported operation
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy