Resize API Gateway Instances with ModifyInstanceSpec - API Gateway

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:ModifyInstanceSpec

update

*All Resource

*

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 elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.