UpdateGateway - Platform For AI - Alibaba Cloud Documentation Center

Update a private gateway.

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:
- 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
eas:UpdateGateway	update	*Gateway `acs:eas:{#regionId}:{#accountId}:gateway/{#GatewayId}`	none	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 used for the private gateway.	ecs.c6.4xlarge
Name	string	No	The private gateway alias.	mygateway1
EnableIntranet	boolean	No	Specifies whether to enable internal network access. Default value: true. Enumeration Value: true: true. false: false.	true
EnableInternet	boolean	No	Specifies whether to enable Internet access. Default value: false. Valid values: true false	false
IsDefault	boolean	No	Indicates whether it is the default private gateway.	true
Replicas	integer	No	The number of nodes in the private gateway.	2
GatewayId	string	Yes	The ID of the private gateway.	gw-1uhcqmsc7x22******
ClusterId	string	Yes	The region of the private gateway.	cn-hangzhou

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-07-31	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-11-16	The request parameters of the API has changed	View Change Details