Querying DNAT Rules

Function

This API is used to query a DNAT rule list.

URI

GET /v2/{project_id}/dnat_rules

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. All optional parameters can be filtered. For details, see the example request.

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
limit	No	Integer	Specifies the number of records on each page.
id	No	String	Specifies the DNAT rule ID.
tenant_id	No	String	Specifies the project ID.
nat_gateway_id	No	String	Specifies the NAT gateway ID.
port_id	No	String	Specifies the port ID of an ECS or a BMS.
private_ip	No	String	Specifies the private IP address of a user, for example, the IP address of a VPC for Direct Connect connection.
internal_service_port	No	Integer	Specifies the port used by ECSs or BMSs to provide services for external systems.
floating_ip_id	No	String	Specifies the EIP ID.
floating_ip_address	No	String	Specifies the EIP.
external_service_port	No	Integer	Specifies the port for providing external services.
protocol	No	String	Specifies the protocol type. Currently, TCP, UDP, and ANY are supported. The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.
description	No	String(255)	Provides supplementary information about the DNAT rule.
status	No	String	Specifies the status of the DNAT rule. For details about all its values, see Resource Status Description.
admin_state_up	No	Boolean	Specifies the unfrozen or frozen state. The value can be: true: indicates the unfrozen state. false: indicates the frozen state.

Request

None

Response

Table 2 lists response parameters.

**Table 2** Response parameters
Parameter	Type	Description
dnat_rules	Array(Object)	Specifies the DNAT rule objects. 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 NAT gateway ID.
port_id	String	Specifies the port ID of an ECS or a BMS.
private_ip	String	Specifies the private IP address of a user, for example, the IP address of a VPC for 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.
external_service_port	Integer	Specifies the port for providing external services.
protocol	String	Specifies the protocol type. Currently, TCP, UDP, and ANY are supported. The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.
description	String(255)	Provides supplementary information about the DNAT rule.
status	String	Specifies the status of the DNAT rule. For details about all its values, see Table 1.
admin_state_up	Boolean	Specifies the unfrozen or frozen state. The value can be: true: indicates the unfrozen state. false: indicates the frozen state.
created_at	String	Specifies when the DNAT rule is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.
internal_service_port_range	String	Specifies the port range used by ECSs or BMSs to provide services for external systems. The port range is the same as the value of external _service_port_range. The value ranges from 1 to 65535.
external_service_port_range	String	Specifies the port range used by the floating IP address for providing external services. The port range is the same as the value of internal _service_port_range. The value ranges from 1 to 65535.

Examples

Example request

GET https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526d/dnat_rules?limit=10

Example response

{ 
     "dnat_rules": [ 
         { 
             "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", 
             "private_ip": "", 
             "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, 
             "description": "my dnat rule 01" 
         }, 
         { 
             "floating_ip_id": "cf99c679-9f41-4dac-8513-9c9228e713e1", 
             "status": "ACTIVE", 
             "nat_gateway_id": "dda3a125-2406-456c-a11f-598e10578541", 
             "admin_state_up": true, 
             "port_id": "", 
             "private_ip": "192.168.1.100", 
             "internal_service_port": 0, 
             "protocol": "any", 
             "tenant_id": "abc", 
             "created_at": "2017-11-16 15:44:42.595173", 
             "id": "89195d50-0271-41f1-bded-4c089b2502ff", 
             "floating_ip_address": "5.21.11.227", 
             "external_service_port": 0, 
             "description": "my dnat rule 01" 
         } 
     ] 
 }