Call the DeleteIpv4Gateway API to delete an IPv4 gateway - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Operation description

Description

Before you delete an IPv4 gateway, make sure that no route tables are associated with the IPv4 gateway.
DeleteIpv4Gateway is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the GetIpv4GatewayAttribute operation to query the status of the task.
- If the IPv4 gateway is in the Deleting state, the IPv4 gateway is being deleted.
- If the IPv4 gateway cannot be queried, the IPv4 gateway is deleted.
After you call the DeleteIpv4Gateway operation to delete an IPv4 gateway, you cannot call the operation again to delete the IPv4 gateway until the deletion task is complete.

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:DeleteIpv4Gateway

delete

*Ipv4Gateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
Ipv4GatewayId	string	Yes	The ID of the IPv4 gateway that you want to delete.	ipv4gw-5tsnc6s4ogsedtp3k****
InternetMode	string	No	The public network mode of the VPC after the IPv4 gateway is deleted. Valid values: private: Default value. The VPC becomes a private network without public network access. public: Public network access for the VPC is no longer centrally controlled by the IPv4 gateway. Instances with public IP addresses can access the Internet by default. Valid values: private : private public : public	public
RegionId	string	Yes	The region ID of the IPv4 gateway that you want to delete. You can call the DescribeRegions operation to query the most recent region list.	ap-southeast-6
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 a dry run. Valid values: true: performs only a dry run, without performing the actual request. 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
RegionId	string	Yes	The region ID of the IPv4 gateway that you want to delete. 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.	21133AC0-0636-521B-A400-253818691A56

Examples

Success response

JSON format

{
  "RequestId": "21133AC0-0636-521B-A400-253818691A56"
}

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.
400	OperationDenied.RouteEntryExist	The operation is not allowed because of existing routeEntry point to ipv4Gateway.	You cannot delete the IPv4 gateway because routes that point to the IPv4 gateway exist.
400	OperationDenied.GatewayAlreadyAssociated	The operation is not allowed because of the specified resource %s is already associated.	The operation is not allowed because the IPv4 gateway is in the Associated state.
400	OperationFailed.Ipv4GatewayUsedByEipBindIpAddress	Failed to delete the IPv4 gateway because the EIP associated with a private IP address requires the IPv4 gateway to implement outbound Internet access.	The EIP is associated with a private IP address and this feature requires an IPv4 gateway. Therefore, you cannot delete the IPv4 gateway.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.