DeleteNatIp - Virtual Private Cloud - Alibaba Cloud Documentation Center

Deletes a NAT IP address.

Operation description

DeleteNatIp 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 ListNatIps operation to query the status of the task.
- If the NAT IP address is in the Deleting state, the NAT IP address is being deleted. In this case, you can only query the NAT IP address but cannot perform other operations.
- If the NAT IP address cannot be found, it is deleted.
You cannot repeatedly call the DeleteNatIp operation to delete a NAT IP address within the specified period of time.

There is currently no authorization information disclosed in the API.

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the NAT gateway to which the NAT IP address that you want to delete belongs. You can call the DescribeRegions operation to query the most recent region list.	cn-qingdao
NatIpId	string	Yes	The ID of the NAT IP address that you want to delete.	vpcnatip-gw8y7q3cpk3fggs87****
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
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.	5A2CFF0E-5718-45B5-9D4D-70B3FF3898

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

Sample success responses

JSONformat

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

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	IncorrectStatus.NatGateway	%The status of %s [%s] is incorrect.	The NAT gateway is in an invalid state.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	The specified region ID does not exist.
404	ResourceNotFound.NatIp	The specified resource of %s is not found.	The specified NatIp parameter 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.	The specified %s resource does not exist.

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

Change time	Summary of changes	Operation
2024-01-18	API Description Update. The Error code has changed	View Change Details
2023-03-01	The Error code has changed	View Change Details