ModifyApiGroup修改API分组-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

修改已经存在的API分组的名称，描述，或者basepath。

接口说明

此功能面向 API 提供者
该接口调用的 QPS 限制为：单用户 QPS 不超过 50

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:ModifyApiGroup

update

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

无

请求参数

名称	类型	必填	描述	示例值
GroupId	string	是	API 分组 ID，系统生成，全局唯一	523e8dc7bbe04613b5b1d726c2a7889d
GroupName	string	否	分组名称，必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~50 个字符，不传递表示不修改	NewWeather
BasePath	string	否	api 根路径	/eeee
Description	string	否	分组描述，不超过 180 个字符，不传递表示不修改	New weather informations.
UserLogConfig	string	否	用户日志配置	{\"requestBody\":false,\"responseBody\":false,\"queryString\":\"\",\"requestHeaders\":\"\",\"responseHeaders\":\"\",\"jwtClaims\":\"\"}
CustomTraceConfig	string	否	自定义 trace 配置	{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}
CompatibleFlags	string	否	关联的标签列表，多个用逗号（,）分隔	depart:dep1
CustomerConfigs	string	否	用户自定义的配置项数据	removeResponseServerHeader
PassthroughHeaders	string	否	透传 Headers	eagleeye-rpcid,x-b3-traceid,host
DefaultDomain	string	否	默认域名	mkt.api.gaore.com
RpcPattern	string	否	rpc 模式	{}
Tag	array<object>	否	指定规则所适用的对象标签，可设置多个。
	object	否	标签列表。
Key	string	是	标签键	env
Value	string	是	标签值	uat
SupportSSE	string	否	是否支持网关向客户端发送事件流，实现实时数据推送	true
FilterAppCodeForBackend	string	否	是否过滤后端请求中的 appcode	false
CustomAppCodeConfig	string	否	自定义 AppCode 配置	{"location":"HEADER","name":"myAppCodeHeader"}
RpsLimitForServerless	string	否

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求唯一标识	4CF287C6-CE5B-477B-BE27-C48F99EADBC8
BasePath	string	api 根路径	/test
GroupId	string	API 分组 ID，系统生成，全局唯一	523e8dc7bbe04613b5b1d726c2a7889d
GroupName	string	API 分组名称	NewWeather
Description	string	API 分组描述	New weather informations.
SubDomain	string	系统为 API 分组分配的二级域名	523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com

示例

正常返回示例

JSON格式

{
  "RequestId": "4CF287C6-CE5B-477B-BE27-C48F99EADBC8",
  "BasePath": "/test",
  "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
  "GroupName": "NewWeather",
  "Description": "New weather informations.",
  "SubDomain": "523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。