Help Center/ API Gateway/ User Guide/ Opening APIs/ Creating an API Group
Updated on 2025-08-28 GMT+08:00

Creating an API Group

An API group contains APIs used for the same service. You can manage APIs by group, and must create a group before creating an API.

You can create an API group using the following methods:

  • Creating an API Group Directly

    You can create APIs for the group as required. For details, see Creating an API group.

  • Importing an API Design File

    Import an API design file to create a group. For details, see Importing APIs through an API Design File.

  • Importing a CSE Microservice

    By importing Cloud Service Engine (CSE) microservices, you can open your CSE service capabilities through APIs. During the import, an API group can be created. For details, see Importing APIs Through CSE Microservices.

  • Importing a CCE Workload

    By importing Cloud Container Engine (CCE) workloads, you can open up your CCE service capabilities. During the import, an API group can be created. For details, see Importing APIs Through CCE Workloads.

Constraints

  • Each API can belong to only one group.
  • The system automatically allocates a subdomain name to each API group for internal testing. The subdomain name can be accessed 1000 times a day. You can also disable the Debugging Domain Name switch on the Group Information page in the console. When disabled, the debugging domain name is hidden and APIs cannot be called through it.
  • The debugging domain name is for debugging only, not for production.
  • By default, the debugging domain name of an API group can only be resolved to a server in the same VPC as the gateway. If you want to resolve the domain name to a public network, bind an EIP to the gateway.

Creating an API group

  1. Go to the APIG console.
  2. Select a dedicated gateway at the top of the navigation pane.
  3. Choose API Management > API Groups.
  4. Choose Create API group > Create Directly, and enter group information based on the following table.

    Table 1 Group information

    Parameter

    Description

    Name

    API group name.

    Enter 3 to 255 characters, starting with a letter or digit. Use only letters, digits, and these special characters: -_./:()

    Description

    Description of the API group. Enter 0 to 1,000 characters.

  5. Click OK.

    If the created API group is displayed in the API group list, the API group is created successfully.

Related Documents

  • After an API group is created, bind domain names to it so that API callers can use them to call open APIs in the group. For details, see Configuring the Domain Name for Calling APIs.
  • Each gateway provides a DEFAULT group. You can call APIs in the default group using the VPC address. For details, see Calling an Open API.