全部产品

快速切换 API 版本

更新时间:2019-02-18 10:56:48

描述

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

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

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:SwitchApi
GroupId String 分组编号
ApiId String API编号
StageName String 运行环境名称,取值:
  • RELEASE:线上
  • TEST:测试
HistoryVersion String 指定要切换到的历史版本号
Description String 切换备注

返回参数

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

示例

请求示例

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=SwitchApi
  2. &ApiId=d6f679aeb3be4b91b3688e887ca1fe16
  3. &StageName=release
  4. &HistoryVersion=20160705104552292
  5. &Description=for_demo
  6. &<公共请求参数>

返回示例

XML格式

  1. <SwitchApiResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ001</RequestId>
  3. </SwitchApiResponse>

JSON格式

  1. {
  2. "RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ001"
  3. }