tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateUDPListeners

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

1. API Description

Domain name for API request: gaap.tencentcloudapi.com.

This API (CreateTCPListeners) is used to batch create UDP 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: CreateUDPListeners.
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).
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.
RealServerPorts.N No Array of Integer List of origin server ports, which only supports the listeners of version 1.0 and connection group.
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.
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.
FailoverSwitch No Integer Whether to enable the primary/secondary origin server mode for failover. Values: 1 (enabled); 0 (disabled). It’s not available if the origin type is DOMAIN.
HealthCheck No Integer Whether the health check is enabled for the origin server. Values: 1 (enabled); 0 (disabled).
CheckType No String The health check type. Values: PORT (port); PING (ping).
CheckPort No Integer The health probe port.
ContextType No String The UDP message type. Values: TEXT (text). This parameter is used only when CheckType = PORT.
SendContext No String The UDP message sent by the health probe port. This parameter is used only when CheckType = PORT.
RecvContext No String The UDP message received by the health probe port. This parameter is used only when CheckType = PORT.

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

This example shows you how to create an UDP listener.

Input Example

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

{
    "ProxyId": "link-bjkpdum1",
    "RealServerType": "IP",
    "ListenerName": "test1",
    "Scheduler": "rr",
    "Ports": [
        "90"
    ]
}

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.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.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.AccountViolation Restricted resources found in your account. Check your inbox and email for details.
UnauthorizedOperation Unauthorized operation.
UnsupportedOperation Unsupported operation
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy