Help Center/ API Gateway/ User Guide/ Managing APIs/ Importing and Exporting APIs/ Importing APIs Through CSE Microservices
Updated on 2025-04-25 GMT+08:00
View PDF
Share

Importing APIs Through CSE Microservices

You can import Cloud Service Engine (CSE) microservices to a gateway as backend services and open APIs in API Gateway for API callers.

  • If your gateway does not support CSE microservice import, contact customer service.
  • CSE microservices can be imported in CN Southwest-Guiyang1, CN East-Shanghai1, CN South-Guangzhou, and CN North-Beijing4.

Precautions

  • Only microservice engines with security authentication disabled can be imported.
  • The network between the current gateway and the target microservice instance must be connected. Otherwise, the generated APIs cannot be called.
  • If no schema is selected, each generated API will use request method ANY, request path /, and prefix matching.
  • After the import, APIs will be generated, together with a microservice load balance channel that monitors and updates address changes of the microservice's online instances.

Prerequisites

You have created a microservice engine.

Importing a CSE Microservice

  1. Go to the APIG console.
  2. Select a gateway at the top of the navigation pane.
  1. In the navigation pane, choose API Management > API Groups.
  2. Choose Create API Group > Import CSE Microservice. Set the parameters according to the following table. For details about microservice engines, see the Cloud Service Engine documentation.

    Table 1 Configuration information

    Parameter

    Description

    Group

    API group to which APIs generated for the imported CSE microservice will belong. You can choose to create a group or select an existing group.

    Type

    HTTP and HTTPS are supported. HTTPS is recommended for transmitting important or sensitive data.

    Microservice Engine

    Select the created microservice engine. Cloud Service Engine (CSE) is cloud middleware used for microservice applications. It provides high-performance, high-resilience enterprise-class cloud service capabilities, such as registry and discovery, service governance, and configuration management.

    Microservice

    Select a microservice under the current engine or create a microservice. Microservices are service processes.

    Microservice Version

    Select the version number of the current microservice. A version marks an iteration record of a microservice to facilitate iteration management.

    Schema

    Select the schema of the current microservice. A schema defines microservice APIs for a server and consumers in compliance with the OpenAPI Specification.

    Path Prefix

    This parameter is available only when Schema is selected.

    You can use a plus sign (+) for prefix matching. For example, /a/{b+}.

  3. Click OK.