开发者社区 问答 正文

API 网关如何修改 API 分组?



描述


用于修改已经存在的API分组的名称或者描述

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


请求参数


名称类型是否必须描述
ActionString接口名称,系统规定参数,取值:ModifyApiGroup
GroupIdStringAPI分组 ID,系统生成,全局唯一
GroupNameString分组名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~50个字符,不传递表示不修改
DescriptionString分组描述,不超过180个字符,不传递表示不修改


返回参数


名称类型描述
RequestIdString请求唯一标识
GroupIDStringAPI分组 ID,系统生成,全局唯一
GroupNameStringAPI分组名称
SubDomainString系统为API分组分配的二级域名
DescriptionStringAPI分组描述


示例



请求示例



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

功能描述: 此API(ModifyApiGroup)允许API提供者修改已存在API分组的名称和描述,以适应业务变化或管理需求。该接口调用频率限制为单用户每秒不超过50次QPS。

请求参数

  • Action(String,必需):接口操作名,固定值为ModifyApiGroup
  • GroupId(String,必需):要修改的API分组ID,由系统生成,全局唯一。
  • GroupName(String,可选):新的分组名称,需确保全局唯一性,支持汉字、英文字母、数字及英文下划线组合,长度4到50个字符,必须以字母或汉字开头。不传递此参数则表示不修改名称。
  • Description(String,可选):分组的新描述信息,字符数不超过180,若不传递则表示不修改描述。

返回参数

  • RequestId(String):本次请求的唯一标识。
  • GroupId(String):API分组的ID。
  • GroupName(String):修改后的API分组名称。
  • SubDomain(String):系统分配给API分组的二级域名。
  • Description(String):修改后的API分组描述。

示例

具体请求示例请参考知识库中提供的文档资料,其中包含了修改API分组信息的请求结构与响应示例。

注意事项

  • 确保GroupName的唯一性,避免与其他分组名称冲突。
  • 注意调用频率限制,以免因超出QPS限制而影响使用。
  • 修改时,未在请求中包含的字段将被视为不进行修改。

通过以上信息,您可以根据实际需要构造请求,以实现对阿里云API分组名称和描述的有效管理。

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