tencent cloud



Last updated: 2022-08-10 17:15:05

    1. API Description

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

    This API (DescribeHTTPSListeners) is used to query HTTPS listener information.

    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: DescribeHTTPSListeners.
    Version Yes String Common Params. The value used for this API: 2018-05-29.
    Region No String Common Params. This parameter is not required for this API.
    ProxyId No String Filter condition. Connection ID.
    ListenerId No String Filter condition. Exact query by listener IDs.
    ListenerName No String Filter condition. Exact query by listener names.
    Port No Integer Filter condition. Exact query by listener ports.
    Offset No Integer Offset. The default value is 0
    Limit No Integer Quantity limit. The default value is 20.
    SearchValue No String Filter condition. It supports fuzzy query by ports or listener names.
    GroupId No String Connection group ID as a filter
    Http3Supported No Integer Specifies whether to enable HTTP3. Valid values:
    0: disable HTTP3;
    1: enable HTTP3.
    Note: If HTTP3 is enabled for a connection, the listener will use the port that is originally accessed to UDP, and a UDP listener with the same port cannot be created.
    After the connection is created, you cannot change your HTTP3 setting.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Quantity of listeners
    ListenerSet Array of HTTPSListener HTTPS listener list
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the HTTPS Listener Information

    Query the HTTPS listener information.

    Input Example

    &<Common request parameters>

    Output Example

    "Response": {
      "TotalCount": 11,
      "ListenerSet": [
          "ForwardProtocol": "HTTPS",
          "ClientCertificateId": null,
          "CertificateId": "Sv8lFuYh",
          "Protocol": "HTTPS",
          "CertificateAlias": "lagameft01_test",
          "AuthType": 0,
          "ListenerId": "listener-eqq49dct",
          "ListenerStatus": 0,
          "ListenerName": "httpstohttps443",
          "ClientCertificateAlias": null,
          "CreateTime": 1563340571,
          "Port": 443
          "ForwardProtocol": "HTTPS",
          "ClientCertificateId": "",
          "CertificateId": "cert-r79xf99t",
          "Protocol": "HTTPS",
          "CertificateAlias": "boris_user001",
          "AuthType": 0,
          "ListenerId": "listener-85646933",
          "ListenerStatus": 0,
          "ListenerName": "testcert001",
          "ClientCertificateAlias": null,
          "CreateTime": 1564201158,
          "Port": 1443
      "RequestId": "db5cebe8-b79a-401c-8704-388776fae938"

    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
    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.NotSupportOldVersionProxy Only connections of Version 2.0 are supported.
    FailedOperation.NotSupportProxyGroup This operation is not supported for connection groups.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    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.
    Contact Us

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

    Technical Support

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

    7x24 Phone Support