文档首页/API网关 APIG/API参考/共享版API（仅存量用户使用）/API分组管理/创建API分组
更新时间：2023-01-05 GMT+08:00
查看PDF
分享

创建API分组

功能介绍

API分组是API的管理单元，一个API分组等同于一个服务入口，创建API分组时，返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。

URI

HTTP/HTTPS请求方法以及URI如下表所示。

表1 HTTP/HTTPS请求方法以及URI

请求方法

URI

POST

/v1.0/apigw/api-groups

请求消息

表2 参数说明

名称

是否必选

类型

说明

name

是

String

API分组的名称。

长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。

说明：

中文字符必须为UTF-8或者unicode编码。

remark

否

String

API分组描述。

长度最大不超过255个字符。

说明：

中文字符必须为UTF-8或者unicode编码。

请求消息样例：

{
	"name": "api_group_001",
	"remark": "分组1"
}

响应消息

表3 参数说明

名称

类型

说明

id

String

编号

name

String

名称

status

Integer

状态

sl_domain

String

系统默认分配的子域名

sl_domains

Array of strings

系统默认分配的子域名列表

register_time

Timestamp

创建时间

update_time

Timestamp

最近修改时间

remark

String

描述

on_sell_status

Integer

是否已上架云商店：

  • 1：已上架
  • 2：未上架
  • 3：审核中

call_limits

Integer

流控时长内分组下的API的总访问次数限制，默认不限，请根据服务的负载能力自行设置

time_interval

Integer

流控时长

time_unit

String

流控的时间单位

url_domains

Array of UrlDomainsResp objects

分组上绑定的独立域名列表

is_default

Integer

是否为默认分组，默认为非默认分组：

  • 1：默认分组
  • 2：非默认分组
表4 UrlDomainsResp

名称

类型

说明

id

String

域名编号

domain

String

访问域名

cname_status

Integer

域名cname状态：

  • 1：未解析
  • 2：解析中
  • 3：解析成功
  • 4：解析失败

ssl_id

String

SSL证书编号

ssl_name

String

SSL证书名称

响应消息样例：

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

状态码

表5 返回消息说明

状态码

说明

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Internal Error

父主题：API分组管理