tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Global Application Acceleration Platform
    Documentation
    Download PDF

    CreateHTTPListener

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

    1. API Description

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

    This API (CreateHTTPListener) is used to create an HTTP listener in the connection instance.

    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: CreateHTTPListener.
    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
    Port Yes Integer Listener port, which is based on the listeners of same transport layer protocol (TCP or UDP). The port must be unique.
    ProxyId No String Connection ID, which cannot be set together with GroupId at the same time. A listener will be created for the corresponding connection.
    GroupId No String Connection group ID, which cannot be set together with ProxyId at the same time. A listener will be created for the corresponding connection group.

    3. Output Parameters

    Parameter Name Type Description
    ListenerId String Created 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 an HTTP listener

    This example shows you how to create an HTTP listener.

    Input Example

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

{
    "ProxyId": "link-cuxw2rm0",
    "ListenerName": "listener-1",
    "Port": "443"
}

    Output Example

    {
    "Response": {
        "RequestId": "9aeda369-17c7-429f-be39-745c1e92fc71",
        "ListenerId": "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.NotSupportProxyGroup This operation is not supported for connection groups.
    FailedOperation.ProxyStatusNotInRuning Unable to add listeners: the connection is not running.
    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
    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