Creating an API Group

Updated on 2025-01-24 GMT+08:00

View PDF

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 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.

NOTE:

API group DEFAULT is automatically generated for each gateway. APIs in this group can be called using the IP address of the Virtual Private Cloud (VPC) where the gateway is deployed.

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

Go to the APIG console.
Select a dedicated gateway at the top of the navigation pane.
Choose API Management > API Groups.

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.