Querying Public NAT Gateways

Function

This API is used to query public NAT gateways.

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 /v2/{project_id}/nat_gateways

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
tenant_id	No	String	Specifies the project ID.
id	No	String	Specifies the public NAT gateway ID.
enterprise_project_id	No	String	Specifies the ID of the enterprise project associated with the public NAT gateway when the gateway is created.
description	No	String	Provides supplementary information about the public NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>).
created_at	No	Datetime	Specifies when the public NAT gateway was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.
name	No	String	Specifies the public NAT gateway name. You can enter up to 64 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed.
status	No	Array of strings	Specifies the public NAT gateway status. The value can be: ACTIVE: The public NAT gateway is available. PENDING_CREATE: The public NAT gateway is being created. PENDING_UPDATE: The public NAT gateway is being updated. PENDING_DELETE: The public NAT gateway is being deleted. INACTIVE: The public NAT gateway is unavailable.
spec	No	Array of strings	Specifies the public NAT gateway specifications. The value can be: 1: small, which supports up to 10,000 SNAT connections. 2: medium, which supports up to 50,000 SNAT connections. 3: large, which supports up to 200,000 SNAT connections. 4: extra large, which supports up to 1,000,000 SNAT connections.
admin_state_up	No	Boolean	Specifies whether the public NAT gateway is frozen. The value can be: true: The public NAT gateway is unfrozen. false: The public NAT gateway is frozen.
internal_network_id	No	String	Specifies the network ID of the downstream interface (the next hop of DVR) of the public NAT gateway. DVR is Distributed Virtual Routing.
router_id	No	String	Specifies the VPC ID.
limit	No	Integer	Specifies the number of records displayed on each page. Value range: 1 to 2000 Default value: 2000
marker	No	String	Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. If parameters marker and limit are not specified, all resource records (2,000 by default) on the first page will be returned. If marker is not specified and limit is set to 10, the first to tenth resource records will be returned. If marker is set to the resource ID of the tenth record and limit is set to 10, the 11th to 20th resource records will be returned. If marker is set to the resource ID of the tenth record and limit is not specified, the 11th and subsequent resource records (2,000 by default) will be returned.
sort_key	No	String	Specifies the key used during sorting.
sort_dir	No	String	Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order).

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 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 4** Response body parameters
Parameter	Type	Description
nat_gateways	Array of NatGatewayResponseBody objects	Specifies the response body for querying public NAT gateways. For details, see the NatGateway description.

**Table 5** NatGatewayResponseBody
Parameter	Type	Description
id	String	Specifies the public NAT gateway ID.
tenant_id	String	Specifies the project ID.
name	String	Specifies the public NAT gateway name. You can enter up to 64 characters.
description	String	Provides supplementary information about the public NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>).
spec	String	Specifies the public NAT gateway specifications. The value can be: 1: small, which supports up to 10,000 SNAT connections. 2: medium, which supports up to 50,000 SNAT connections. 3: large, which supports up to 200,000 SNAT connections. 4: extra large, which supports up to 1,000,000 SNAT connections.
status	String	Specifies the public NAT gateway status. The value can be: ACTIVE: The public NAT gateway is available. PENDING_CREATE: The public NAT gateway is being created. PENDING_UPDATE: The public NAT gateway is being updated. PENDING_DELETE: The public NAT gateway is being deleted. INACTIVE: The public NAT gateway is unavailable.
admin_state_up	Boolean	Specifies whether the public NAT gateway is frozen. The value can be: true: The public NAT gateway is unfrozen. false: The public NAT gateway is frozen.
created_at	Datetime	Specifies when the public NAT gateway was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.
router_id	String	Specifies the VPC ID.
internal_network_id	String	Specifies the network ID of the downstream interface (the next hop of DVR) of the public NAT gateway. DVR is Distributed Virtual Routing.
enterprise_project_id	String	Specifies the ID of the enterprise project associated with the public NAT gateway when the gateway is created.
session_conf	SessionConfiguration object	Specifies the session parameters for the public NAT gateway.
ngport_ip_address	String	Specifies the private IP address of the public NAT gateway, which is assigned by the VPC subnet.
billing_info	String	Specifies the order information. This parameter is available only when you buy a yearly/monthly resource. This parameter is left blank when your buy a pay-per-use resource.
dnat_rules_limit	Long	Specifies the maximum number of DNAT rules on a public NAT gateway. The default value is 200.
snat_rule_public_ip_limit	Integer	Specifies the maximum number of EIPs in an SNAT rule on a public NAT gateway. The default value is 20.
pps_max	Integer	Specifies the maximum number of data packets that can be received or sent by a NAT gateway per second, indicating its traffic handling capacity.
bps_max	Integer	Specifies the maximum amount of data that can be transmitted over the public NAT gateway per second. Unit: Mbit/s

**Table 6** SessionConfiguration
Parameter	Type	Description
tcp_session_expire_time	Integer	Specifies the TCP session duration. Unit: second
udp_session_expire_time	Integer	Specifies the UDP session duration. Unit: second
icmp_session_expire_time	Integer	Specifies the ICMP session duration. Unit: second
tcp_time_wait_time	Integer	Specifies how long the side that actively closed the TCP connection is in the TIME_WAIT state. Unit: second

Example Requests

GET https://{NAT_endpoint}/v2/27e25061336f4af590faeabeb7fcd9a3/nat_gateways?status=ACTIVE

Example Responses

Status code: 200

Query operation succeeded.

{
  "nat_gateways" : [ {
    "id" : "a253be25-ae7c-4013-978b-3c0785eccd63",
    "router_id" : "b1d81744-5165-48b8-916e-e56626feb88f",
    "status" : "ACTIVE",
    "description" : "nat01",
    "admin_state_up" : true,
    "tenant_id" : "27e25061336f4af590faeabeb7fcd9a3",
    "created_at" : "2017-11-15 14:50:39.505112",
    "spec" : "2",
    "internal_network_id" : "5930796a-6026-4d8b-8790-6c6bfc9f87e8",
    "name" : "wj3",
    "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
    "billing_info" : null,
    "dnat_rules_limit" : 200,
    "snat_rule_public_ip_limit" : 20,
    "ngport_ip_address" : "192.168.0.138",
    "session_conf" : {
      "tcp_session_expire_time" : 900,
      "udp_session_expire_time" : 300,
      "icmp_session_expire_time" : 10,
      "tcp_time_wait_time" : 5
    }
  }, {
    "id" : "e824f1b4-4290-4ebc-8322-cfff370dbd1e",
    "router_id" : "305dc52f-13dd-429b-a2d4-444a1039ba0b",
    "status" : "ACTIVE",
    "description" : "1234",
    "admin_state_up" : true,
    "tenant_id" : "27e25061336f4af590faeabeb7fcd9a3",
    "created_at" : "2017-11-17 07:41:07.538062",
    "spec" : "2",
    "internal_network_id" : "fc09463b-4ef8-4c7a-93c8-92d9ca6daf9d",
    "name" : "lyl001",
    "enterprise_project_id" : "0",
    "billing_info" : null,
    "dnat_rules_limit" : 200,
    "snat_rule_public_ip_limit" : 20,
    "ngport_ip_address" : "192.168.5.210",
    "session_conf" : {
      "tcp_session_expire_time" : 900,
      "udp_session_expire_time" : 300,
      "icmp_session_expire_time" : 10,
      "tcp_time_wait_time" : 5
    }
  } ]
}