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.

Calling Method¶

For details, see Calling APIs.

URI¶

POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id	Yes	String	Gateway ID, which can be obtained from the gateway information on the APIG console.

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
name	Yes	String	API group name. The value can contain 3 to 255 characters, including letters, digits, and special characters `(-_./():).` It must start with a letter or digit. Minimum: 3 Maximum: 255
remark	No	String	API group description. Maximum: 1000
roma_app_id	No	String	ID of the integration application to which the API group belongs. This parameter is required when the group version is V2. Currently, this parameter is not supported.
version	No	String	Group version. V1: global group V2: application-level group The default value is V1. This parameter is not supported currently.

Response Parameters¶

Status code: 201

**Table 4** Response body parameters¶
Parameter	Type	Description
id	String	ID.
name	String	API group name.
status	Integer	Status. 1: valid Enumeration values: 1
sl_domain	String	Subdomain name that APIG automatically allocates to the API group.
register_time	String	Creation time.
update_time	String	Last modification time.
on_sell_status	Integer	Indicates whether the API group has been listed on KooGallery. 1: listed 2: not listed 3: under review Not supported currently.
url_domains	Array of UrlDomain objects	Independent domain names bound to the API group.
sl_domain_access_enabled	Boolean	Whether the debugging domain name is accessible. Options: true and false. Default: true
sl_domains	Array of strings	Automatically allocated subdomain names.
remark	String	Description.
call_limits	Integer	Total number of times all APIs in the API group can be accessed. Consider the payload capacity of the backend service when setting this parameter. By default, there is no limit on the number of API calls. Currently, this parameter is not supported.
time_interval	Integer	Period of time for limiting the number of API calls. Currently, this parameter is not supported.
time_unit	String	Time unit for limiting the number of API calls. Currently, this parameter is not supported.
is_default	Integer	Indicates whether the API group is the default group. 1: Yes 2: No
version	String	Group version. V1: global group V2: application-level group The default value is V1. This parameter is not supported currently.
roma_app_id	String	ID of the integration application to which the API group belongs. This parameter is required when the group version is V2. Currently, this parameter is not supported.
roma_app_name	String	Name of the integration application to which the API group belongs. Currently, this parameter is not supported.

**Table 5** UrlDomain¶
Parameter	Type	Description
id	String	Domain ID.
domain	String	Domain name.
cname_status	Integer	CNAME resolution status of the domain name. 1: not resolved 2: resolving 3: resolved 4: resolution failed
ssl_id	String	SSL certificate ID.
ssl_name	String	SSL certificate name.
min_ssl_version	String	Minimum SSL version. TLS 1.1 and TLS 1.2 are supported. Default: TLSv1.1 Enumeration values: TLSv1.1 TLSv1.2
verified_client_certificate_enabled	Boolean	Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. Default: false
is_has_trusted_root_ca	Boolean	Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. Default: false

Status code: 400

**Table 6** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 7** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 8** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests¶

Creating an API group

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

Example Responses¶

Status code: 201

Created

{
  "update_time" : "2020-07-31T06:55:55.383169299Z",
  "name" : "api_group_001",
  "on_sell_status" : 2,
  "remark" : "API group 1",
  "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
  "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
  "id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "register_time" : "2020-07-31T06:55:55.383169068Z",
  "status" : 1,
  "is_default" : 2,
  "sl_domain_access_enabled" : true
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes¶

Status Code	Description
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal Server Error

Error Codes¶

See Error Codes.

last updated: 2024-12-13 16:21 UTC - commit: 9ff5103dad551eb3fcc6439582ab3ab13e6670f5