ModifyInstanceSpec - API Gateway - Alibaba Cloud Documentation Center

Upgrades or downgrades the configurations of an API Gateway instance.

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.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:ModifyInstanceSpec	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	apigateway-cn-v6419k43xxxxx
InstanceSpec	string	Yes	The specifications of the instance.	api.s1.small
AutoPay	boolean	No	Specifies whether payment is automatically made during renewal. Valid values: True: Automatic payment is enabled. Make sure that your Alibaba Cloud account has adequate balance. False: Automatic payment is disabled. You have to manually pay in the console. Log on to the console. In the upper-right corner, choose Expenses > User Center. In the left-side navigation pane, click Orders. On the page that appears, find your order and complete the payment. Default value: False.	true
Token	string	Yes	The password.	b5845042-2f2f-4e96-bd5c-36c6e5c2a68c
ModifyAction	string	No	Specifies whether to upgrade or downgrade the instance. Valid values: UPGRADE DOWNGRADE Default value: UPGRADE.	UPGRADE
SkipWaitSwitch	boolean	No	Specifies whether to skip the Waiting for Traffic Switchover state. During the upgrade or downgrade, a new outbound IP address may be added to the API Gateway instance. The Waiting for Traffic Switchover state is used to remind users of adding the new outbound IP address to the whitelist. If you set the SkipWaitSwitch parameter to true, the instance does not enter the Waiting for Traffic Switchover state when a new outbound IP address is available. Instead, the system sends internal messages to the user.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	36BBBAD4-1CFB-489F-841A-8CA52EEA787E

Examples

Sample success responses

JSONformat

{
  "RequestId": "36BBBAD4-1CFB-489F-841A-8CA52EEA787E"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-14	API Description Update	View Change Details