UpdateGateway - Platform For AI - Alibaba Cloud Documentation Center

Updates a private 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

eas:UpdateGateway

update

*Gateway

acs:eas:{#regionId}:{#accountId}:gateway/{#GatewayId}

None

Request syntax

PUT /api/v2/gateways/{ClusterId}/{GatewayId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
InstanceType	string	No	The instance type of the private gateway. Valid values: 2c4g 4c8g 8c16g 16c32g	2c4g
Name	string	No	The alias of the private gateway.	mygateway1
EnableIntranet	boolean	No	Specifies whether to enable intranet access. The default value is true. Valid values: true : Enables intranet access. false : Disables intranet access.	true
EnableInternet	boolean	No	Specifies whether to enable public network access. The default value is false. Valid values: true : Enables public network access. false : Disables public network access.	false
IsDefault	boolean	No	Specifies whether the gateway is the default private gateway.	true
Replicas	integer	No	The number of private gateway nodes.	2
EnableSSLRedirection	boolean	No	Specifies whether to enable HTTP to HTTPS redirection. The default value is false.	false
VpcId	string	No	The VPC where the gateway resides. This parameter applies only to application-type dedicated gateways.	vpc-bp1jkde2******3mew
VSwitchIds	array	No	The list of vSwitches. This parameter applies only to application-type dedicated gateways.
	string	No	The vSwitch ID.	vsw-wz9mof1ucpr8se7******
GatewayId	string	Yes	The ID of the private gateway. To obtain the ID, see the private_gateway_id field in the response of the ListResources operation.	gw-1uhcqmsc7x22******
ClusterId	string	Yes	The region where the private gateway is located.	cn-wulanchabu

Response elements

Element	Type	Description	Example
	object	The response.
GatewayId	string	The ID of the private gateway.	gw-1uhcqmsc7x22******
RequestId	string	The request ID.	40325405-579C-4D82***
Message	string	The returned message.	Gateway is updated

Examples

Success response

JSON format

{
  "GatewayId": "gw-1uhcqmsc7x22******",
  "RequestId": "40325405-579C-4D82***",
  "Message": "Gateway is updated"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.