Querying DNAT Rules

Function

This API is used to query DNAT rules.

Constraints

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.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/private-nat/dnat-rules

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. Minimum: 1 Maximum: 36

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Specifies the number of records displayed on each page. The value ranges from 0 to 2000. Default value: 2000 Minimum: 1 Maximum: 2000 Default: 2000
marker	No	String	Specifies the start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. The value is obtained from next_marker or previous_marker in PageInfo queried last time. Minimum: 36 Maximum: 36
page_reverse	No	Boolean	Specifies whether to query the previous page.
id	No	Array	Specifies the DNAT rule ID. Array Length: 1 - 10
project_id	No	Array	Specifies the project ID. Array Length: 1 - 10
enterprise_project_id	No	Array	Specifies the ID of the enterprise project that is associated with the DNAT rule when the DNAT rule is being created. Array Length: 1 - 10
description	No	Array	Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>). Array Length: 1 - 10
gateway_id	No	Array	Specifies the private NAT gateway ID. Array Length: 1 - 10
transit_ip_id	No	Array	Specifies the ID of the transit IP address. Array Length: 1 - 10
external_ip_address	No	Array	Specifies the transit IP address. Array Length: 1 - 10
network_interface_id	No	Array	Specifies the network interface ID. Network interfaces of an Elastic Cloud Server (ECS), load balancer, or virtual IP address are supported. Array Length: 1 - 10
type	No	Array	Specifies the backend resource type of the DNAT rule. The type can be: COMPUTE: The backend resource is a compute instance. VIP: The backend resource is a virtual IP address. ELB: The backend resource is a shared load balancer. ELBv3: The backend resource is a dedicated load balancer. CUSTOMIZE: The backend resource is a user-defined IP address. Array Length: 1 - 10
private_ip_address	No	Array	Specifies the private IP address of the backend instance. Array Length: 1 - 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It is a response to the API used to obtain 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. Minimum: 1 Maximum: 10240

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
dnat_rules	Array of PrivateDnat objects	Specifies the response body for querying DNAT rules. Array Length: 0 - 2000
request_id	String	Specifies the request ID. Minimum: 1 Maximum: 36
page_info	PageInfo object	Specifies the pagination information.

**Table 5** PrivateDnat
Parameter	Type	Description
id	String	Specifies the DNAT rule ID. Minimum: 36 Maximum: 36
project_id	String	Specifies the project ID. Minimum: 36 Maximum: 36
description	String	Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>). Minimum: 1 Maximum: 36
transit_ip_id	String	Specifies the ID of the transit IP address. Minimum: 36 Maximum: 36
gateway_id	String	Specifies the private NAT gateway ID. Minimum: 1 Maximum: 36
network_interface_id	String	Specifies the network interface ID. Network interfaces of a compute instance, load balancer, virtual IP address are supported. Minimum: 1 Maximum: 36
type	String	Specifies the backend resource type of the DNAT rule. The type can be: COMPUTE: The backend resource is a compute instance. VIP: The backend resource is a virtual IP address. ELB: The backend resource is a load balancer. ELBv3: The backend resource is a dedicated load balancer. CUSTOMIZE: The backend resource is a user-defined IP address. Minimum: 1 Maximum: 10
protocol	String	Specifies the protocol type. TCP, UDP, and ANY are supported. The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively. Minimum: 1 Maximum: 3 Enumeration values: tcp udp any
private_ip_address	String	Specifies the private IP address of the backend instance. Minimum: 7 Maximum: 15
internal_service_port	String	Specifies the port number of the backend instance. Minimum: 0 Maximum: 65535 Minimum: 1 Maximum: 5
transit_service_port	String	Specifies the port number of the transit IP address. Minimum: 0 Maximum: 65535 Minimum: 1 Maximum: 5
enterprise_project_id	String	Specifies the ID of the enterprise project that is associated with the DNAT rule when the DNAT rule is being created. Minimum: 1 Maximum: 36
created_at	String	Specifies when the DNAT rule was created. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format. Minimum: 1 Maximum: 36
updated_at	String	Specifies when the DNAT rule was updated. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format. Minimum: 1 Maximum: 36

**Table 6** PageInfo
Parameter	Type	Description
next_marker	String	Specifies the ID of the last record in this query, which can be used in the next query. Minimum: 1 Maximum: 36
previous_marker	String	Specifies the ID of the first record in the pagination query result. When page_reverse is set to true, this parameter is used together to query resources on the previous page. Minimum: 1 Maximum: 36
current_count	Integer	Specifies the ID of the last record in the pagination query result. It is usually used to query resources on the next page. Minimum: 1 Maximum: 2000

Example Requests

GET https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/dnat-rules

Example Responses

Status code: 200

DNAT rules queried.

{
  "dnat_rules" : [ {
    "id" : "24dd6bf5-48f2-4915-ad0b-5bb111d39c83",
    "project_id" : "da261828016849188f4dcc2ef94d9da9",
    "description" : "aa",
    "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec",
    "transit_ip_id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "network_interface_id" : "dae9393a-b536-491c-a5a2-72edc1104707",
    "type" : "COMPUTE",
    "protocol" : "any",
    "internal_service_port" : "0",
    "transit_service_port" : "0",
    "private_ip_address" : "192.168.1.72",
    "created_at" : "2019-04-29T07:10:01",
    "updated_at" : "2019-04-29T07:10:01"
  }, {
    "id" : "25dcdb21-97de-43cd-b476-31637a47f05d",
    "project_id" : "da261828016849188f4dcc2ef94d9da9",
    "description" : "aa",
    "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec",
    "transit_ip_id" : "15abdf29-4a68-474c-9963-79c4e6d495d7",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "network_interface_id" : "9e2f0dbb-68b2-4c4b-9298-fa4f13187976",
    "type" : "COMPUTE",
    "protocol" : "any",
    "internal_service_port" : "0",
    "transit_service_port" : "0",
    "private_ip_address" : "192.168.1.99",
    "created_at" : "2019-04-29T07:15:41",
    "updated_at" : "2019-04-29T07:15:41"
  } ],
  "request_id" : "a7b00469-5a31-4274-bb10-59167243383e",
  "page_info" : {
    "previous_marker" : "14338426-6afe-4019-996b-018008113013",
    "current_count" : 2
  }
}