创建API分组。
接口说明
创建 API 需要先创建分组,所属分组是 API 的一个基本属性信息。
- 此功能面向 API 提供者。
- 每个用户每个区域下最多可创建 100 个分组。
- 系统自动给分组分配二级域名,用于测试 API。
- 分组带有区域属性,后续创建 API 选择分组后就选择了区域,为减少网络延时,建议选择与后端服务相同的区域。
- 创建分组后,可为分组绑定已备案的自定义域名。
- 该接口调用的 QPS 限制为:单用户 QPS 不超过 50。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
apigateway:CreateApiGroup | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
GroupName | string | 是 | 分组名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~50 个字符。 | Weather |
BasePath | string | 否 | api 根路径 | /qqq |
Description | string | 否 | API 分组描述,不超过 180 个字符。 | The weather informations. |
InstanceId | string | 否 | 实例 ID | apigateway-cn-v6419k43xxxxx |
Tag | array<object> | 否 | 指定规则所适用的对象标签,可设置多个。 | Key, Value |
object | 否 | |||
Key | string | 否 | 标签的 key | key |
Value | string | 否 | 标签的 value | value |
返回参数
示例
正常返回示例
JSON
格式
{
"TagStatus": true,
"BasePath": "/qqq",
"RequestId": "FF3B7D81-66AE-47E0-BF69-157DCF187514",
"Description": "The weather informations",
"GroupName": "Weather",
"GroupId": "523e8dc7bbe04613b5b1d726c2a7xx",
"InstanceId": "apigateway-cn-v6419k43xxxxx",
"SubDomain": "523e8dc7bbe04613b5b1d726xxxxxxxx-cn-hangzhou.alicloudapi.com",
"InstanceType": "VPC_SHARED"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-11-14 | OpenAPI 描述信息更新 | 查看变更详情 |