Call the DeleteNatIp API to delete a NAT IP address - NAT Gateway - Alibaba Cloud - NAT Gateway

Deletes a NAT IP address.

Operation description

DeleteNatIp is an asynchronous operation. After you send a request, the system returns a request ID, but the NAT IP address is not yet deleted. The deletion task continues to run in the background. You can call ListNatIps to query the deletion status of the NAT IP address:

If the NAT IP address is in the Deleting state, the NAT IP address is being deleted. In this state, you can only perform query operations.
If the NAT IP address cannot be found, the NAT IP address is deleted.

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

delete

*NatGateway

acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the NAT gateway to which the NAT IP address belongs. You can call DescribeRegions to query the region ID.	cn-qingdao
NatIpId	string	No	The instance ID of the NAT IP address that you want to delete.	vpcnatip-gw8y7q3cpk3fggs87****
NatGatewayId	string	No	The instance ID of the NAT gateway to which the IP prefix belongs. This parameter is required when you delete an IP prefix.	ngw-gw8v16wgvtq26vh59****
Ipv4Prefix	string	No	The IP prefix to delete.	192.168.0.0/28
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run without deleting the NAT IP address. The system checks the AccessKey pair, the authorization of the Resource Access Management (RAM) user, and the required parameters. If the check fails, the corresponding error is returned. If the check succeeds, the error code `DryRunOperation` is returned. false (default): sends a Normal request. If the check succeeds, a 2xx HTTP status code is returned and the NAT IP address is deleted.	false
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 ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
RegionId	string	Yes	The region ID of the NAT gateway to which the NAT IP address belongs. You can call DescribeRegions to query the region ID.	cn-qingdao

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	E9AD97A0-5338-43F8-8A80-5E274CCBA11B

Examples

Success response

JSON format

{
  "RequestId": "E9AD97A0-5338-43F8-8A80-5E274CCBA11B"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.NatIp	The status of %s [%s] is incorrect.	The status of NatIp is incorrect.
400	OperationFailed.DefaultNatIp	The operation is failed because of default NatIP can not be deleted.	You cannot delete the default NAT IP address.
400	DependencyViolation.NatIp	The specified resource of %s depends on %s, so the operation cannot be completed.	You cannot perform the operation because the NAT gateway is associated with a NAT IP address.
400	IncorrectStatus.NatGateway	The status of %s [%s] is incorrect.
400	DependencyViolation.FullNatEntry	The fullnat entry depends on this nat ip,so the operation cannot be completed.	The operation failed because the FULLNAT entry depends on the NAT IP.
400	IllegalParam.NatIp	The param of %s is illegal.	The parameter NatIp is illegal.
400	Mismatch.Ipv4PrefixAndNatIpCidr	The %s and %s are mismatched.
400	Mismatch.Ipv4PrefixAndCidrReservations	The %s and %s are mismatched.	The reserved network segments of the Ipv4Prefix and VSwitch do not match.
400	IllegalParam.Ipv4Prefix	The param of %s is illegal.	The parameter Ipv4Prefix is illegal.
400	DependencyViolation.%s	The specified resource of [%s] depends on [%s], so the operation cannot be completed.	The specified resource of [%s] depends on [%s], so the operation cannot be completed.
400	DependencyViolation.SnatEntry	The specified resource of %s depends on %s, so the operation cannot be completed.	The SnatEntry associated with NatIp or Ipv4Prefix cannot be deleted. Delete the dependent Snat and delete it again.
400	DependencyViolation.Ipv4Prefix	The specified resource of %s depends on %s, so the operation cannot be completed.	NatIp belongs to Ipv4Prefix and cannot be deleted separately. Please delete the Ipv4Prefix directly.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.
404	ResourceNotFound.NatIp	The specified resource of %s is not found.
404	ResourceNotFound.NatGateway	The specified resource of %s is not found.
404	ResourceNotFound.NatIpCidr	The specified resource of %s is not found.
404	ResourceNotFound.%s	The specified resource of %s is not found.	The specified resource of %s is not found.
404	ResourceNotFound.Ipv4Prefix	The specified resource of %s is not found.	Resource Ipv4Prefix not found, please check that the Ipv4Prefix exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.