Updated on 2025-07-04 GMT+08:00

Querying Details of a DNAT Rule

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/dnat_rules/{dnat_rule_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

dnat_rule_id

Yes

String

Specifies the DNAT rule ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

The value of X-Subject-Token in the response header is the token value.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

dnat_rule

NatGatewayDnatRuleResponseBody object

Specifies the response body of the DNAT rule.

Table 4 NatGatewayDnatRuleResponseBody

Parameter

Type

Description

id

String

Specifies the DNAT rule ID.

tenant_id

String

Specifies the project ID.

description

String

Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

port_id

String

Specifies the port ID of an ECS or BMS. This parameter applies to VPC scenarios. Configure either port_id or private_ip.

private_ip

String

Specifies the private IP address of a user. This parameter applies to Direct Connect and Cloud Connect scenarios. Configure either private_ip or port_id.

internal_service_port

Integer

Specifies the port used by ECSs or BMSs to provide services for external systems.

Supported range: 0 to 65535

nat_gateway_id

String

Specifies the public NAT gateway ID.

global_eip_id

String

Specifies the global EIP ID. Configure either the EIP ID or the global EIP ID.

global_eip_address

String

Specifies the global EIP.

floating_ip_id

String

Specifies the EIP ID.

floating_ip_address

String

Specifies the EIP address.

external_service_port

Integer

Specifies the port used by the floating IP address to provide services for external systems.

Supported range: 0 to 65535

status

String

Specifies the DNAT rule status.

The value can be:

  • ACTIVE: The DNAT rule is available.

  • PENDING_CREATE: The DNAT rule is being created.

  • PENDING_UPDATE: The DNAT rule is being updated.

  • PENDING_DELETE: The DNAT rule is being deleted.

  • EIP_FREEZED: The EIP is frozen.

  • INACTIVE: The DNAT rule is unavailable.

admin_state_up

Boolean

Specifies whether the DNAT rule is frozen.

The value can be:

  • true: The DNAT rule is unfrozen.

  • false: The DNAT rule is frozen.

internal_service_port_range

String

Specifies the port range used by ECSs or BMSs to provide services for external systems.

The number of ports must be the same as that of external _service_port_range.

The value ranges from 1 to 65535.

Specify two port numbers connected by a single hyphen (-) and no blank spaces in the x-y format, where x is lower than y.

external_service_port_range

String

Specifies the port range used by the floating IP address to provide services for external systems.

The number of ports must be the same as that of internal _service_port_range.

The value ranges from 1 to 65535.

Specify two port numbers connected by a single hyphen (-) and no blank spaces in the x-y format, where x is lower than y.

protocol

String

Specifies the protocol. TCP, UDP, and ANY are supported.

The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.

created_at

Datetime

Specifies when the DNAT rule was created. The time is in yyyy-mm-dd hh:mm:ss.SSSSSS format.

Example Requests

GET https://{NAT_endpoint}/v2/d199ba7e0ba64899b2e81518104b1526d/dnat_rules/5b95c675-69c2-4656-ba06-58ff72e1d338

  

Example Responses

Status code: 200

DNAT rule details queried.

{
  "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",
    "private_ip" : "",
    "internal_service_port" : 993,
    "protocol" : "tcp",
    "tenant_id" : "d199ba7e0ba64899b2e81518104b1526d",
    "created_at" : "2017-11-15 15:44:42.595173",
    "id" : "5b95c675-69c2-4656-ba06-58ff72e1d338",
    "floating_ip_address" : "5.21.11.226",
    "external_service_port" : 242,
    "description" : "my dnat rule 01"
  }
}

Status Codes

Status Code

Description

200

DNAT rule details queried.

Error Codes

See Error Codes.