All Products
Search
Document Center

Virtual Private Cloud:DeleteNatIp

Last Updated:Mar 04, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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
NatIpIdstringYes

The ID of the NAT IP address that you want to delete.

vpcnatip-gw8y7q3cpk3fggs87****
DryRunbooleanNo

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
ClientTokenstringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

E9AD97A0-5338-43F8-8A80-5E274CCBA11B

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400IncorrectStatus.NatIpThe status of %s [%s] is incorrect.The status of NatIp is incorrect.
400OperationFailed.DefaultNatIpThe operation is failed because of default NatIP can not be deleted.You cannot delete the default NAT IP address.
400DependencyViolation.NatIpThe 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.
400IncorrectStatus.NatGatewayThe status of %s [%s] is incorrect.-
400IncorrectStatus.NatGateway%The status of %s [%s] is incorrect.The NAT gateway is in an invalid state.
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.The specified region ID does not exist.
404ResourceNotFound.NatIpThe specified resource of %s is not found.The specified NatIp parameter is not found.
404ResourceNotFound.NatGatewayThe specified resource of %s is not found.-
404ResourceNotFound.NatIpCidrThe 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 history

Change timeSummary of changesOperation
2024-01-18API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 404
2023-03-01The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404