All Products
Search
Document Center

NAT Gateway:DeleteForwardEntry

Last Updated:Mar 05, 2024

Deletes a DNAT entry.

Operation description

Description

  • DeleteForwardEntry 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 DescribeForwardTableEntries operation to query the status of the task.

    • If the DNAT entry is in the Deleting state, the system is deleting the DNAT entry. In this case, you can only query the status of the DNAT entry, but cannot perform other operations.
    • If the DNAT entry cannot be found, it is deleted.
Note If a DNAT table has DNAT entries in the Pending state, you cannot delete the DNAT entries.
  • You cannot repeatedly call the DeleteForwardEntry operation to delete a DNAT entry 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

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:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DeleteForwardEntryWrite
  • ForwardTable
    acs:vpc:{#regionId}:{#accountId}:forwardtable/{#ForwardTableId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the NAT gateway.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ForwardTableIdstringYes

The ID of the DNAT table to which the DNAT entry belongs.

ftb-8vbx8xu2lqj9qb334****
ForwardEntryIdstringYes

The ID of the DNAT entry to be deleted.

fwd-8vbn3bc8roygjp0gy****
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.
123e4567-e89b-12d3-a456-426655440000

Response parameters

ParameterTypeDescriptionExample
object

The request ID.

RequestIdstring

The request ID.

0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Sample success responses

JSONformat

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

Error codes

HTTP status codeError codeError messageDescription
400IncorretForwardEntryStatusSome Forward entry status blocked this operation..The operation is not supported because one or more DNAT entries in the DNAT table are in the Pending or Modifying state.
400IncorretForwardEntryStatusThe Specified forwardEntry is not stable status, can not operation-
400IncorretForwardEntryStatusThe Specified forwardEntry is not existThe specified DNAT entry does not exist.
400MissingParameterMissing mandatory parameterRequired parameters are not specified. Check whether you have specified all required parameters before you call this operation.
400IncorrectStatus.NATGWThe status of the specified NAT gateway is abnormal.The status of the specified NAT gateway is abnormal.
400IncorrectStatus.ForwardEntryThe status of %s [%s] is incorrect.The DNAT entry to be deleted is in an invalid state.
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.The specified region ID does not exist.
404InvalidForwardEntryId.NotFoundSpecified forward entry ID does not existThe specified DNAT entry does not exist.
404InvalidForwardTableId.NotFoundSpecified forward table does not exist.The specified DNAT table does not exist. Check the parameter and try again.
404ResourceNotFound.ForwardEntryThe 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
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