Updating a Public NAT Gateway

Function

This API is used to update a public NAT gateway.

Constraints

The name, description, and specifications of a public NAT gateway can be updated when admin_state_up is set to True and status is ACTIVE.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/nat_gateways/{nat_gateway_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
nat_gateway_id	Yes	String	Specifies the public NAT gateway 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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
nat_gateway	Yes	UpdateNatGatewayOption object	Specifies the request body for updating the public NAT gateway.

**Table 4** UpdateNatGatewayOption
Parameter	Mandatory	Type	Description
name	No	String	Specifies the public NAT gateway name. You can enter up to 64 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed.
description	No	String	Provides supplementary information about the public NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>).
spec	No	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. 5: enterprise-class, which supports up to 10,000,000 SNAT connections.
session_conf	No	SessionConfiguration object	Specifies the session parameters for the public NAT gateway.
prepaid_options	No	prepaid_options object	Specifies the payment attributes.

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

**Table 6** prepaid_options
Parameter	Mandatory	Type	Description
is_auto_pay	No	Boolean	Specifies whether to enable automatic payment.

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
nat_gateway	NatGatewayResponseBody object	Specifies the response body for a public NAT gateway.
order_id	String	Specifies the order ID.

**Table 8** 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. 5: enterprise-class, which supports up to 10,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	String	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 9** 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

PUT https://{NAT_endpoint}/v2/70505c941b9b4dfd82fd351932328a2f/nat_gateways/14338426-6afe-4019-996b-3a9525296e11

{
  "nat_gateway" : {
    "name" : "new_name",
    "description" : "new description",
    "spec" : "1"
  }
}

Example Responses

Status code: 200

Public NAT gateway updated.

{
  "nat_gateway" : {
    "id" : "14338426-6afe-4019-996b-3a9525296e11",
    "name" : "new_name",
    "description" : "new description",
    "spec" : "1",
    "tenant_id" : "70505c941b9b4dfd82fd351932328a2f",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "status" : "ACTIVE",
    "created_at" : "2019-04-22T08:47:13",
    "internal_network_id" : "89d66639-aacb-4929-969d-07080b0f9fd9",
    "router_id" : "d84f345c-80a1-4fa2-a39c-d0d397c3f09a",
    "admin_state_up" : true,
    "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
    }
  }
}