首页 API 网关 开发指南 API参考指南 API目录 分组 ModifyApiGroup - 修改API分组的信息

ModifyApiGroup - 修改API分组的信息

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

接口说明

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:ModifyApiGroupWrite
  • ApiGateway
    acs:apigateway:*:{#accountId}:*

请求参数

名称类型必填描述示例值
GroupIdstring

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

523e8dc7bbe04613b5b1d726c2a7889d
GroupNamestring

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

NewWeather
BasePathstring

api根路径

/eeee
Descriptionstring

分组描述,不超过180个字符,不传递表示不修改

New weather informations.
UserLogConfigstring

用户日志配置

{\"requestBody\":false,\"responseBody\":false,\"queryString\":\"\",\"requestHeaders\":\"\",\"responseHeaders\":\"\",\"jwtClaims\":\"\"}
CustomTraceConfigstring

自定义trace配置

{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}
CompatibleFlagsstring

关联的标签列表,多个用逗号(,)分隔

depart:dep1
CustomerConfigsstring

用户自定义的配置项数据

removeResponseServerHeader
PassthroughHeadersstring

透传 Headers

eagleeye-rpcid,x-b3-traceid,host
DefaultDomainstring

默认域名

mkt.api.gaore.com
RpcPatternstring

rpc模式

Tagarray

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

object

标签列表。

Keystring

标签键

env
Valuestring

标签值

uat

返回参数

名称类型描述示例值
object
RequestIdstring

请求唯一标识

4CF287C6-CE5B-477B-BE27-C48F99EADBC8
BasePathstring

api根路径

/test
GroupIdstring

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

523e8dc7bbe04613b5b1d726c2a7889d
GroupNamestring

API分组名称

NewWeather
Descriptionstring

API分组描述

New weather informations.
SubDomainstring

系统为API分组分配的二级域名

523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com

示例

正常返回示例

JSON格式

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

XML格式

<ModifyApiGroupResponse>
    <RequestId>4CF287C6-CE5B-477B-BE27-C48F99EADBC8</RequestId>
    <GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>
    <GroupName>NewWeather</GroupName>
    <SubDomain>523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com</SubDomain>
    <Description>New weather informations.</Description>
</ModifyApiGroupResponse>

错误码

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

阿里云首页 API 网关 相关技术圈