Deletes a NAT IP address.
Operation description
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.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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 |
|---|---|---|---|---|
| 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 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**** |
| NatGatewayId | string | No | The ID of the NAT gateway instance to which the IP prefix to be deleted belongs. Required when deleting an IP prefix. | ngw-gw8v16wgvtq26vh59**** |
| Ipv4Prefix | string | No | The IP prefix address to be deleted. | 192.168.0.0/28 |
| DryRun | boolean | No | Specifies whether to perform only a dry run, without performing the actual request. Valid values:
| 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 |
Response parameters
Examples
Sample success responses
JSONformat
{
"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 | IncorrectStatus.NatGateway | %The status of %s [%s] is incorrect. | The NAT gateway is in an invalid state. |
| 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. | The Ipv4Prefix and NatIpCidr 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. | 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. |
| 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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-11-03 | The Error code has changed | View Change Details |
| 2025-03-26 | The Error code has changed | View Change Details |
| 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 |
