创建API分组
创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。
目前支持以下创建分组方式:
- 直接创建
创建一个简单的分组,不包含API,用户可自行创建API。具体步骤请参见创建API分组。
- 导入API设计文件
从本地导入已有的API设计文件,并同步创建API分组。具体步骤请参见通过API设计文件导入API。
- 导入CSE微服务
导入微服务引擎(Cloud Service Engine,简称CSE)的微服务,提供API注册开放CSE服务能力。导入时,可同步创建API分组。具体步骤请参见通过CSE微服务导入API。
- 导入CCE工作负载
导入云容器引擎(Cloud Container Engine,简称CCE)工作负载,开放CCE服务能力。导入时,可同步创建API分组。具体步骤请参见通过CCE工作负载导入API。
约束与限制
- 一个API只能属于一个API分组。
- API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。您也可以在控制台上API分组详情的“分组信息”页面关闭“调试域名开关”来关闭调试域名,关闭后将隐藏调试域名,且不能通过调试域名调用API。
- 调试域名不能用于生产业务,且仅限应用程序调试使用。
- 调试域名默认只能在与实例相同VPC内的服务器上解析和访问,如果调试域名要支持公网解析与访问,请在实例上绑定公网入口弹性IP。
创建API分组
- 进入API网关控制台页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“API管理 > API分组”。
- 单击“创建API分组 > 直接创建”,根据下表参数说明,在弹框中填写分组信息。
表1 分组信息表 参数
说明
分组名称
API分组名称,用于将API接口进行分组管理。
支持中文、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字或数字开头,长度为3~255个字符。
描述
对分组的介绍。长度为0~1000个字符。
- 单击“确定”,创建完成。
在API分组列表中显示已创建的API分组,表示分组创建成功。
相关文档
- API分组创建成功后,您可以为此分组绑定域名,API调用者通过访问域名调用开放的API。绑定域名具体操作,请参考配置API的调用域名。
- 每个APIG实例提供一个DEFAULT分组,您可以直接通过虚拟私有云地址调用默认分组中的API。具体调用详情,请参考调用APIG开放的API。