Help Center/ NAT Gateway/ API Reference/ Out-of-Date APIs/ API v2.0/ DNAT Rules/ Querying Details About a DNAT Rule

Updated on 2025-12-26 GMT+08:00

View PDF

Querying Details About a DNAT Rule

Function

This API is used to query details about a DNAT rule.

URI

GET /v2.0/dnat_rules/{dnat_rule_id}

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
dnat_rule_id	String	Yes	Specifies the DNAT rule ID.

Request

None

Response

Table 2 lists response parameter.

**Table 2** Response parameter
Parameter	Type	Description
dnat_rule	Object	Specifies the DNAT rule object. For details, see Table 3.

**Table 3** Description of the **dnat_rule** field
Parameter	Type	Description
id	String	Specifies the DNAT rule ID.
tenant_id	String	Specifies the project ID.
nat_gateway_id	String	Specifies the public NAT gateway ID.
port_id	String	Specifies the port ID of an ECS or BMS.
private_ip	String	Specifies the private IP address of a user, for example, the IP address of a VPC connected by a Direct Connect connection.
internal_service_port	Integer	Specifies the port used by ECSs or BMSs to provide services for external systems.
floating_ip_id	String	Specifies the EIP ID.
floating_ip_address	String	Specifies the EIP address.
external_service_port	Integer	Specifies the port for providing services for external systems.
protocol	String	Specifies the protocol. Its value can be tcp (6), udp (17), or any (0).
status	String	Specifies the status of the DNAT rule. For details about all its values, see Table 1.
admin_state_up	Boolean
created_at	String	Specifies when the DNAT rule was created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

Examples

Example request

GET https://{Endpoint}/v2.0/dnat_rules/5b95c675-69c2-4656-ba06-58ff72e1d338

Example response

{              
  "dnat_rule": {
        "floating_ip_id": "bf99c679-9f41-4dac-8513-9c9228e713e1",
        "status": "ACTIVE",
        "nat_gateway_id": "cda3a125-2406-456c-a11f-598e10578541",
        "admin_state_up": true,
        "port_id": "9a469561-daac-4c94-88f5-39366e5ea193",
        "internal_service_port": 993,
        "protocol": "TCP",
        "tenant_id": "abc",
        "created_at": "2017-11-15 15:44:42.595173",
        "id": "79195d50-0271-41f1-bded-4c089b2502ff",
        "floating_ip_address": "5.21.11.226",
        "external_service_port": 242
        "private_ip": ""  
   }
}