开发者社区 问答 正文

如何快速切换 API 版本?



描述


用指定历史版本切换掉指定环境中正在运行中的API定义,即用历史定义替换运行中定义。

  • 此功能面向开放API的用户
  • 历史版本号可通过DescribeHistoryApis接口获取
  • 发布超过1次的API才可以切换
  • 切换针对的是运行中API,切换操作不可逆且迅速生效,需谨慎;切换有一定的延迟性,最长不超过5s
  • 切换本质上也是一次发布操作,需要说明切换的原因


请求参数


名称类型是否必须描述
ActionString操作接口名,系统规定参数,取值:SwitchApi
GroupIdString分组编号
ApiIdStringAPI编号
StageNameString运行环境名称,取值:
  • RELEASE: 线上
  • TEST: 测试
HistoryVersionString指定要切换到的历史版本号
DescriptionString切换备注


返回参数


名称类型描述
RequestIdString本次请求编号


示例



请求示例



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

功能描述: 在阿里云API网关中,您可以使用SwitchApi接口实现将指定历史版本的API定义切换到当前正在运行的环境中,以此达到快速回滚或更新API的目的。此操作直接生效且不可逆,适用于需要紧急恢复至稳定版本或部署特定历史版本场景的开放API用户。

前提条件: - 确保您要切换的API至少发布过一次,以获取有效的历史版本号,通过DescribeHistoryApis接口可查询到这些信息。 - 您拥有足够的权限执行此操作,具体授权信息为apigateway:SwitchApi,属于更新级别权限,关联资源类型为ApiGroup

请求参数: - Action: 必填,固定值SwitchApi,标识调用的操作接口。 - GroupId: 必填,API所属的分组编号。 - ApiId: 必填,要切换版本的API编号。 - StageName: 必填,指定要操作的环境名称,如RELEASE(线上),TEST(测试)等。 - HistoryVersion: 必填,欲切换到的历史版本号。 - Description: 必填,关于此次切换的简短描述,限200字内。

返回参数: - RequestId: 请求的唯一标识符,用于追踪和日志记录。

注意事项: - 不可逆性:切换操作一旦执行立即生效且无法撤销,请在操作前做好充分验证。 - 延迟性:虽然操作迅速,但实际生效可能存在最长5秒的延迟,请考虑这一因素于系统设计中。 - 发布逻辑:切换过程实质上是一次新的发布操作,因此提供一个清晰的Description有助于后续审计与管理。 - 谨慎操作:确保理解所选历史版本的影响范围,避免对现有服务造成不必要的干扰。

示例: 具体的请求构造方法及响应示例,请参考知识库中的详细说明文档,其中包含了如何在OpenAPI Explorer中直接调试该接口以及成功执行后的响应示例。

综上所述,通过调用SwitchApi接口并合理配置上述参数,您可以高效地完成API历史版本的切换工作,实现对API定义的灵活管理和快速调整。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答
问答分类:
API
问答标签:
问答地址: