调用SwitchApi指定历史版本切换掉指定环境中正在运行中的API定义,即用历史定义替换运行中定义。
- 此功能面向开放API的用户
- 历史版本号可通过DescribeHistoryApis接口获取
- 发布超过1次的API才可以切换
- 切换针对的是运行中API,切换操作不可逆且迅速生效,需谨慎;切换有一定的延迟性,最长不超过5s
- 切换本质上也是一次发布操作,需要说明切换的原因
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ApiId | String | 是 | d6f679aeb3be4b91b3688e887ca1fe16 |
API编号 |
Description | String | 是 | for_demo |
切换备注 |
GroupId | String | 是 | 123 |
分组编号 |
HistoryVersion | String | 是 | 20160705104552292 |
指定要切换到的历史版本号 |
StageName | String | 是 | RELEASE |
运行环境名称,取值:
|
Action | String | 否 | SwitchApi |
操作接口名,系统规定参数,取值:SwitchApi。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | CEF72CEB-54B6-4AE8-B225-F876FF7BZ001 |
请求ID |
示例
请求示例
http(s)://apigateway.cn-qingdao.aliyuncs.com/?Action=SwitchApi
&ApiId=d6f679aeb3be4b91b3688e887ca1fe16
&Description=for_demo
&GroupId=123
&HistoryVersion=20160705104552292
&StageName=RELEASE
&<公共请求参数>
正常返回示例
XML
格式
<SwitchApiResponse>
<RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ001</RequestId>
</SwitchApiResponse>
JSON
格式
{
"RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ001"
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交