开发者社区 问答 正文

API 网关如何创建 API 分组?



描述


创建API分组,创建API需要先创建分组,所属分组是API的一个基本属性信息

  • 此功能面向API提供者
  • 每个用户每个区域下最多可创建50个分组
  • 系统自动给分组分配二级域名,用于测试API
  • 分组带有区域属性,后续创建API选择分组后就选择了区域,为减少网络延时,建议选择与后端服务相同的区域
  • 创建分组后,可为分组绑定已备案的自定义域名
  • 该接口调用的QPS限制为:单用户QPS不超过50


请求参数


名称类型是否必须描述
ActionString接口名称,系统规定参数,取值:CreateApiGroup
GroupNameString分组名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~50个字符
DescriptionStringAPI分组描述,不超过180个字符


返回参数


名称类型描述
RequestIdString请求唯一标识
GroupIDStringAPI分组 ID,系统生成,全局唯一
GroupNameStringAPI分组名称
SubDomainString系统给分组绑定的二级域名,用于测试API调用
DescriptionStringAPI分组描述


示例



请求示例



展开
收起
轩墨 2017-10-26 13:39:07 1892 分享 版权
阿里云 AI 助理回答

创建API分组是阿里云API网关服务中的一项基础功能,旨在帮助API提供者组织和管理其API资源。以下是创建API分组的详细说明及操作指导:

功能描述

创建API分组主要用于在阿里云上组织API,作为API的基本属性信息承载单元。每个用户在每个区域最多能创建100个分组,而非50个。这一步是后续创建API的前提,确保了API能够被有效管理和调用。

前提条件

  • 权限要求:用户需具备apigateway:CreateApiGroup的操作权限。
  • 环境准备:选择与后端服务相同区域以减少网络延迟,并考虑是否需要绑定自定义域名(需备案)。

请求参数

  • Action: CreateApiGroup,固定值,标识此接口操作。
  • GroupName: 必填,分组名称,确保全局唯一,支持字符包括汉字、英文字母、数字及英文下划线,长度4到50个字符,且必须以字母或汉字开头。
  • Description: 可选,对API分组的描述,不超过180个字符。

返回参数

  • RequestId: 每次请求的唯一标识。
  • GroupId: 系统生成的API分组ID,全局唯一。
  • GroupName: 分组的实际名称。
  • SubDomain: 分配给分组的二级域名,用于API测试调用。
  • Description: 分组的描述信息。

示例

具体请求示例及返回结果请参考知识库资料中的示例部分,其中展示了成功创建API分组后的响应详情,包含TagStatus、BasePath等字段,尽管这些在问题描述中未直接提及,但提供了完整的响应结构示例。

注意事项

  • QPS限制:单用户调用此接口的QPS不应超过50。
  • 区域选择:建议与后端服务同区部署,优化通信效率。
  • 自定义域名:创建后可绑定,适用于生产环境,需完成备案流程。

最佳实践

  • 在创建分组时,合理规划分组命名规则,便于后期管理和维护。
  • 考虑到调试便利性与正式使用场景,适时绑定自定义域名并注意QPS控制,以避免影响服务稳定性。

通过遵循上述指南,您可以高效地在阿里云API网关中创建和管理API分组,为您的API部署奠定坚实的基础。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答