Last updated: 2021-10-08 15:11:02

1. API Description

Domain name for API request:

This API (CreateHTTPListener) is used to create an HTTPS 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 parameter. The value used for this API: CreateHTTPSListener.
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
Port Yes Integer Listener port, which is based on the listeners of same transport layer protocol (TCP or UDP). The port must be unique.
CertificateId Yes String Server certificate ID
ForwardProtocol Yes String Protocol types of the forwarding from acceleration connection to origin server: HTTP | HTTPS
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.
AuthType No Integer Authentication type, where:
0: one-way authentication;
1: mutual authentication.
The one-way authentication is used by default.
ClientCertificateId No String Client CA certificate ID, which is required only when the mutual authentication is adopted.
PolyClientCertificateIds.N No Array of String IDs of multiple new client CA certificates. This field or the ClientCertificateId field is required for mutual authentication only.
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 HTTPS listener

This example shows you how to create an HTTPS listener.

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "RequestId": "9aeda369-17c7-429f-be39-745c1e92fc71",
    "ListenerId": "listener-o0f3at99"

5. Developer Resources


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
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.ProxyStatusNotInRuning Unable to add listeners: the connection is not running.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.DuplicatedListenerPort Listener port already exists.
InvalidParameterValue.InvalidCertificateId Certificate unavailable.
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.