edit-icon download-icon

Create an API group

Last Updated: Jan 22, 2018

Description

To create an API group, you must firstly create a group which is a basic attribute of the API.

  • This API is intended for API providers.
  • Up to 100 API groups can be created in each region on a per-user basis.
  • Second-level domain names are automatically assigned to API groups for API testing.
  • API groups have the region attribute. After you create an API and select a group for the API, the corresponding region is also selected. We recommend that you select the region where your backend services are located for reducing network delay.
  • After you create an API group, you can bind a filed custom domain name to the group.
  • This API can call up to 50 QPS for a single user.

Request parameters

Name Type Required? Description
Action String Yes Interface name, which is a required parameter; value: CreateApiGroup.
GroupName String Yes Group name, which must be globally unique and contain 4–50 characters including Chinese characters, English letters, numbers, and English-style underscores. The group name must start with an English letter or a Chinese character.
Description String Yes API group description, which cannot exceed 180 characters.

Return parameters

Name Type Description
RequestId String Unique request ID.
GroupID String API group ID, which is generated by the system and globally unique.
GroupName String API group name.
SubDomain String Second-level domain name bound to the API group, which is used for API call testing.
Description String API group description.

Examples

Request example

  1. http://apigateway.cn-hangzhou.aliyuncs.com?Action=CreateApiGroup
  2. &GroupName=Weather
  3. &Description=The weather informations.
  4. &<Public request parameters>

Response example

XML format

  1. <CreateApiGroupResponse>
  2. <RequestId>FF3B7D81-66AE-47E0-BF69-157DCF187514</RequestId>
  3. <GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>
  4. <GroupName>Weather</GroupName>
  5. <SubDomain>523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com</SubDomain>
  6. <Description>The weather informations</Description>
  7. </CreateApiGroupResponse>

JSON format

  1. {
  2. "RequestId": "FF3B7D81-66AE-47E0-BF69-157DCF187514",
  3. "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
  4. "GroupName": "Weather",
  5. "SubDomain": "523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com",
  6. "Description": "The weather informations"
  7. }
Thank you! We've received your feedback.