All Products
Search
Document Center

API Gateway:SwitchApi

Last Updated:Sep 26, 2023

Switches the definition of an API in a specified runtime environment to a historical version.

Operation Description

  • This API is intended for API providers.
  • The historical version can be obtained by calling the DescribeHistoryApis operation.
  • Only APIs that have been published more than once have historical versions.
  • This operation can only be performed on running APIs. Exercise caution when you perform this operation because the operation cannot be undone. The operation takes up to 5 seconds.
  • The switch operation is essentially a publish operation. A reason for this operation must be provided.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:SwitchApiRead
  • All Resources
    acs:apigateway:*:{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdstringNo

The ID of the API group.

123
ApiIdstringYes

The ID of the API.

d6f679aeb3be4b91b3688e887ca1fe16
StageNamestringYes

The name of the runtime environment. Valid values:

  • RELEASE
  • TEST
RELEASE
DescriptionstringYes

The description of the switch operation.

for_demo
HistoryVersionstringYes

The historical version that you want to switch to.

20160705104552292

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ001

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.