首页 API 网关 开发指南 API参考指南 API目录 API管理 SwitchApi - 切换指定环境中正在运行中的API定义

SwitchApi - 切换指定环境中正在运行中的API定义

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

接口说明

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

调试

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

调试

授权信息

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

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

请求参数

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

分组编号

123
ApiIdstring

API编号

d6f679aeb3be4b91b3688e887ca1fe16
StageNamestring

运行环境名称,取值:

  • RELEASE:线上
  • TEST:测试
RELEASE
Descriptionstring

切换备注

for_demo
HistoryVersionstring

指定要切换到的历史版本号

20160705104552292

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ001

示例

正常返回示例

JSON格式

{
    "RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ001"
}

XML格式

<SwitchApiResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ001</RequestId>        
</SwitchApiResponse>

错误码

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

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