Help Center> API Gateway> API Reference> Dedicated Gateway APIs (V1) (To Be Deprecated)> API Group Management> Creating an API Group
View PDF

Creating an API Group

Function

This API is used to create an API group. An API group is an API management unit and the entry to a service. A subdomain name is returned as the access entry when an API group is created. APIs in an API group should be correlated with each other.

Dedicated API gateways now provide V2 APIs for certain functions. It is recommended that you use V2 APIs to manage your service APIs.

URI

The following table lists the HTTP/HTTPS request method and URI of the API.

Table 1 HTTP/HTTPS request method and URI

Request Method

URI

POST

/v1/{project_id}/apigw/instances/{instance_id}/api-groups

The following table lists the parameters in the URI.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained by the administrator on the My Credentials page.

instance_id

Yes

String

Instance ID, which can be obtained from the dedicated gateway information on the API Gateway console.

Request

Table 3 Parameter description

Parameter

Mandatory

Type

Description

name

Yes

String

API group name.

An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.

remark

No

String

Description of the API group.

The description cannot exceed 255 characters.

Example request:

{
	"name": "api_group_001",
	"remark": "API group 1"
}

Response

Table 4 Parameter description

Parameter

Type

Description

id

String

API group ID

name

String

API group name

status

Integer

Status of the API group

sl_domain

String

Subdomain name automatically allocated by the system to the API group

register_time

Timestamp

Time when the API group is created

update_time

Timestamp

Time when the API group was last modified

remark

String

Description of the API group

on_sell_status

Integer

Indicates whether the API group has been listed on the marketplace. The value can be:

  • 1: listed
  • 2: not listed
  • 3: under approval

call_limits

Integer

Total number of times all APIs in the API group can be accessed. Set this parameter while considering the payload capacity of the backend service. By default, there is no limit on the number of API calls.

time_interval

Integer

Period of time for limiting the number of API calls

time_unit

String

Time unit for limiting the number of API calls

url_domains

Dictionary

List of independent domain names bound to the API group

is_default

Integer

Indicates whether the API group is the default API group. By default, the API group is not the default API group. The value can be:

  • 1: default API group
  • 2: non-default API group

Example response:

{
	"id": "7efb2b91-155a-4f6a-9f45-c5c95a6e4950",
	"name": "api_group_001",
	"status": 1,
	"sl_domain": "0e91b83b-0774-4e8e-b187-2d695ed4743b.apigw.example.com",
	"remark": "API group 1",
	"register_time": "2017-12-28T11:44:53.831282304Z",
	"update_time": "2017-12-28T11:44:53.831283436Z",
	"on_sell_status": 2,
        "is_default": 2
}

Status Codes

Table 5 Status codes

Status Code

Description

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Internal Error
Parent topic: API Group Management