Call UpdateIpv4GatewayAttribute to modify IPv4 gateway name or description - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Operation description

You cannot repeatedly call the UpdateIpv4GatewayAttribute operation to modify the name or description of an IPv4 gateway within the specified period of time.

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

vpc:UpdateIpv4GatewayAttribute

update

*Ipv4Gateway

acs:vpc:{#regionId}:{#accountId}:ipv4gateway/{#ipv4gatewayId}

None

Request parameters

Parameter	Type	Required	Description	Example
Ipv4GatewayId	string	Yes	The ID of the IPv4 gateway whose name or description you want to modify.	ipv4gw-5tsnc6s4ogsedtp3k****
Ipv4GatewayName	string	No	The new name of the IPv4 gateway.	newname
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false
Ipv4GatewayDescription	string	No	The new description of the IPv4 gateway.	new
RegionId	string	Yes	The region ID of the IPv4 gateway whose name or description you want to modify. You can call the DescribeRegions operation to query the most recent region list.	ap-southeast-6
RegionId	string	Yes	The region ID of the IPv4 gateway whose name or description you want to modify. You can call the DescribeRegions operation to query the most recent region list.	ap-southeast-6

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	671CEB03-C98D-5916-950C-C55B0BD06621

Examples

Success response

JSON format

{
  "RequestId": "671CEB03-C98D-5916-950C-C55B0BD06621"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.Ipv4Gateway	The specified resource ipv4Gateway is not found.	The IPv4 gateway is not found and cannot be deleted.
400	IncorrectStatus.Ipv4Gateway	The status of %s [%s] is incorrect.	The IPv4 gateway is in an invalid state. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.