SwitchApi - API Gateway - Alibaba Cloud Documentation Center

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:SwitchApi	update	ApiGroup acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The API group ID.	123
ApiId	string	Yes	The API ID.	d6f679aeb3be4b91b3688e887ca1fe16
StageName	string	Yes	The environment. Valid values: RELEASE: the production environment PRE: the staging environment TEST: the test environment	RELEASE
Description	string	Yes	The description. The description can be up to 200 characters in length.	for_demo
HistoryVersion	string	Yes	The historical version number of the API.	20160705104552292

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	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.

Change history

Change time	Summary of changes	Operation

No change history