tencent cloud


Creating APIs Connecting to the Public URL/IP Backend

Last updated: 2021-02-09 15:04:06


    This document describes how to create an API connecting to the public URL/IP in the backend through the API Gateway console.


    You have created a service.


    Step 1. Create a general API

    1. Log in to the API Gateway console and click Service in the left sidebar.
    2. In the service list, click the name of the target service to view it.
    3. In the service details, click the Manage API tab and choose to create a General API based on the backend business type.
    4. Click Create for subsequent configuration.

    Step 2. Perform frontend configuration

    The frontend configuration of an API refers to the relevant configurations provided for external access, including the API name, frontend type, request protocol, HTTP method, URL path, and input parameter definition.

    Configuring basic frontend information

    • API Name: name of the API you create, which must be unique within the current service and can contain up to 60 characters.
    • Frontend Type: supports HTTP&HTTPS and WS&WSS.
    • Path: You can write a valid URL path as needed. If you need to configure dynamic parameters in the path, please use {} to enclose the parameter names. For example, the /user/{userid} path declares the userid parameter in the path, which must be defined as a path-type input parameter. Query parameters do not need to be defined in the URL path.
      Regular expression match is supported. Taking /user as an example of the path:
      • =/user: indicates exact match. When there are multiple APIs with /user, APIs configured with =/user have the highest matching priority.
      • /user/{id}: indicates that there is a dynamic parameter in the path. When there are multiple APIs with /user, APIs configured with a dynamic parameter have the third-highest matching priority.
      • /user: indicates access by exact match or prefix match. /user, /usertest, and /user/test/a all can access APIs with the path of /user.
    • Request Method: supports GET, POST, PUT, DELETE, and HEAD.
    • Authentication Type: supports No authentication, Key pari, and OAuth 2.0.
    • CORS is supported: configures cross-origin resource sharing (CORS). If enabled, Access-Control-Allow-Origin : * will be added to the response header by default.

    Configuring frontend parameters

    Input parameters: the input parameters include parameters from the header, query, and path, where a path parameter corresponds to a dynamic parameter defined in the URL path. For any parameter, the parameter name, parameter type, and parameter data type must be specified, and whether it is required, its default value, sample data, and description can be specified optionally. With these configuration items, API Gateway helps you with documentation and preliminary verification of input parameters.


    • If the request protocol is HTTPS, a request must carry SNI. To ensure request security, API Gateway will deny requests without SNI.
    • SNI (Server Name Indication) is an extension to TLS. It is used to address situations where a server has multiple domain names and is supported by the protocol since TLSv1.2. Previous SSL handshake messages didn't carry the destination address to be accessed by the client. If a server has multiple virtual hosts, each of which has a unique domain name and uses a unique certificate, then it will not be able to determine which certificate to return to the client. SNI addresses this issue by providing the host information in Client Hello.

    Step 3. Configure public URL/IP in the backend

    The backend configuration of an API refers to the configuration that actually provides the service. API Gateway converts a frontend request based on the backend configuration and forwards the call to the actual service.
    If your business is deployed in other cloud vendors, or your local server opens using public URL/IP, please choose public URL/IP as the backend type.

    Configuration instructions:

    1. If public URL/IP is connected to in the backend, set Backend Type to Public URL/IP.
    2. Enter the backend domain name that starts with http:// or https:// and does not include the path behind, for example, http://api.myservice.com or
    3. Enter the backend path that starts with /, for example, /path or /path/{petid}.
    4. Select the request method. The request methods for the frontend and the backend can be different.
    5. Set the backend timeout (up to 30 seconds). When API Gateway calls the backend service, but the response is not returned within the specified timeout, API Gateway will terminate the call and return the corresponding error message.
    6. Set the backend parameters that map the frontend.
    7. Click Next and configure the response result.

    Step 4. Configure the response

    API response configuration: includes the configuration of API response data and API error codes.
    API response data configuration: indicates the type of returned data, including the data samples of successful and failed calls.
    API error code definition: indicates the additional error code, error message, and description.


    Currently, API Gateway directly passes through the response result to the requester without processing it. When the SDK documentation is generated, the entered sample responses will also be displayed in the documentation, which will help users better understand the meanings of APIs.

    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