Call the DescribeDnatEntryAttributes API to view the details of a DNAT rule.

Instructions

If multiple request parameters are provided, the system will query based on these parameters and return all DNAT rules that meet all the specified conditions. An empty list is returned if no qualified DNAT rules exist.

If no optional parameters are provided, the system will query based on the currently logged-in account, and return all DNAT rules under that account.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.

Action string required Example: DescribeDnatEntryAttributes

The action that you want to perform. Value: DescribeDnatEntryAttributes.

Version string required Example: 2020-04-01

The API version. Value: 2020-04-01.

DnatEntryId string required Example: dnat-342abc3bc3****

ID of the DNAT rule.

Response parameters

The following only details response parameters specific to this API. For more information, see Response structure.

ExternalPort string Example: 34

The port or port range for receiving external requests from the internet.

RequestId string Example: 2021062415303301022514515207C4****

Request ID.

NatGatewayId string Example: ngw-2feq5xhimd88w59gp686****

The ID of the NAT gateway to which the DNAT rule belongs.

DnatEntryId string Example: dnat-342abc3bc3****

The ID of the DNAT rule.

DnatEntryName string Example: dnat-01

The name of the DNAT rule.

Status string Example: Available

The status of the DNAT rule.

Creating

Deleting

Available

InternalIp string Example: 192.XX.XX.88

The private IP address of the Elastic Compute Service (ECS) instance.

InternalPort string Example: 12

The port or port range of the private IP address in the ECS instance.

ExternalIp string Example: 12.XX.XX.34

The IP address used by the NAT gateway for network address translation.

If the NAT gateway is an Internet NAT gateway, specify its associated elastic IP address (EIP).

If the NAT gateway is a VPC NAT gateway, provide its NAT IP address.

Protocol string Example: tcp

Protocol type.

tcp: Forward TCP messages.

udp: Forward UDP messages.

PortType string Example: specified

The port type of the DNAT rule.

specified: The specified port.

any: Any port. That is, IP mapping.

Request examples

Response examples

Error codes

The table below describes the error codes for this API that are associated with business logic. For details, see Common error codes.

Status code	Error codes	Error message	Description
400	MissingParameter	The request is missing a required parameter.	This request does not contain required parameters.
400	InvalidParameter	A parameter specified in the request is not valid, is unsupported or cannot be used.	The request contains invalid or unsupported parameters.
404	InvalidDnatEntry.NotFound	The specified DNAT entry does not exist.	The specified DNAT rule does not exist.
500	InternalError	An internal error has occurred.	An internal error occurred.

NAT Gateway