CreateApiGroup_API 网关_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

流控信息

请求速率为50/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
apigateway:CreateApiGroup
Create
ApiGroup
acs:apigateway:{#regionId}:{#accountId}:apigroup/*

请求参数

字段名称字段详情
GroupNamestring

分组名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~50 个字符。

示例值:Weather参考取值来源:
    DescribeApiGroup
    ModifyApiGroup
BasePathstring

api 根路径

示例值:/qqq
Descriptionstring

API 分组描述,不超过 180 个字符。

示例值:The weather informations.
InstanceIdstring

实例 ID

示例值:apigateway-cn-v6419k43xxxxx参考取值来源:
    CreateInstance
    DescribeInstances
Tagarray<object>

指定规则所适用的对象标签,可设置多个。

示例值:Key, Value子级条数 <= 500

返回参数

字段名称字段详情
TagStatusboolean

标签是否存在,取值:-true:存在-false:不存在

示例值:True
BasePathstring

api 根路径

示例值:/qqq
RequestIdstring

请求唯一标识

示例值:FF3B7D81-66AE-47E0-BF69-157DCF187514
Descriptionstring

API 分组描述

示例值:The weather informations
GroupNamestring

API 分组名称

示例值:Weather
GroupIdstring

API 分组 ID,系统生成,全局唯一

示例值:523e8dc7bbe04613b5b1d726c2a7xx
InstanceIdstring

实例 ID

示例值:apigateway-cn-v6419k43xxxxx
SubDomainstring

系统给分组绑定的二级域名,用于测试 API 调用

示例值:523e8dc7bbe04613b5b1d726xxxxxxxx-cn-hangzhou.alicloudapi.com
InstanceTypestring

实例类型展开详情

示例值:VPC_SHARED

返回示例

变更历史

暂无变更历史

相关示例