Updating an SNAT Rule

Function

This API is used to update an SNAT rule.

Constraints

You can update the EIP ID only when status of the SNAT rule is set to ACTIVE and admin_state_up of the NAT gateway administrator to True.

You can update the description only when status of the SNAT rule is set to ACTIVE and admin_state_up of the NAT gateway administrator to True.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/snat_rules/{snat_rule_id}

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
snat_rule	Yes	UpdateNatGatewaySnatRuleOption object	Specifies the request body for updating the SNAT rule.

**Table 4** UpdateNatGatewaySnatRuleOption
Parameter	Mandatory	Type	Description
nat_gateway_id	Yes	String	Specifies the public NAT gateway ID.
public_ip_address	No	String	Specifies the EIP. Use commas (,) to separate multiple EIPs. Maximum number of EIP IDs: 20
global_eip_id	No	String	Specifies the global EIP ID.
description	No	String	Provides supplementary information about the SNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
snat_rule	NatGatewayUpdateSnatRuleResponseBody object	Specifies the response body for updating the SNAT rule.

**Table 6** NatGatewayUpdateSnatRuleResponseBody
Parameter	Type	Description
id	String	Specifies the SNAT rule ID.
tenant_id	String	Specifies the project ID.
nat_gateway_id	String	Specifies the public NAT gateway ID.
source_type	Integer	0: VPC. Either network_id or cidr can be specified. 1: Direct Connect/Cloud Connect. Only cidr can be specified. If no value is entered, default value 0 (VPC) is used.
cidr	String	Specifies a CIDR block or a host IP address. Configure either cidr or network_id. If you set source_type to 0, set cidr to a subset of the VPC subnet. If you set source_type to 1, set cidr to a CIDR block of your private networks connected to the VPC through Direct Connect or Cloud Connect.
floating_ip_id	String	Specifies the EIP ID. Use commas (,) to separate multiple EIP IDs.
description	String	Provides supplementary information about the SNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).
status	String	Specifies the SNAT rule status. The value can be: ACTIVE: The SNAT rule is available. PENDING_CREATE: The SNAT rule is being created. PENDING_UPDATE: The SNAT rule is being updated. PENDING_DELETE: The SNAT rule is being deleted. EIP_FREEZED: The EIP is frozen. INACTIVE: The SNAT rule is unavailable.
created_at	String	Specifies when the SNAT rule was created. The time is in yyyy-mm-dd hh:mm:ss.SSSSSS format.
network_id	String	Specifies the network ID used by the SNAT rule. Configure either network_id or cidr.
admin_state_up	Boolean	Specifies whether the SNAT rule is frozen. The value can be: true: The SNAT rule is unfrozen. false: The SNAT rule is frozen.
floating_ip_address	String	Specifies the EIP. Use commas (,) to separate multiple EIPs.
public_ip_address	String	Specifies the EIP. Use commas (,) to separate multiple EIPs.
global_eip_address	String	Specifies the global EIP.
global_eip_id	String	Specifies the global EIP ID.

Example Requests

Updating the SNAT rule

PUT https://{NAT_endpoint}/v2/27e25061336f4af590faeabeb7fcd9a3/snat_rules/5b95c675-69c2-4656-ba06-58ff72e1d338

{
  "snat_rule" : {
    "nat_gateway_id" : "bbe7c2e7-3bad-445b-a067-b30acce66053",
    "description" : "my_snat_rule_update",
    "public_ip_address" : "10.15.10.11,10.15.10.12"
  }
}

Example Responses

Status code: 200

Normal response to PUT requests.

{
  "snat_rule" : {
    "floating_ip_id" : "bdc10a4c-d81a-41ec-adf7-de857f7c812a,7a094014-9657-463f-972b-e84d56b931a0",
    "status" : "PENDING_CREATE",
    "nat_gateway_id" : "bbe7c2e7-3bad-445b-a067-b30acce66053",
    "admin_state_up" : true,
    "network_id" : "eaad9cd6-2372-4be1-9535-9bd37210ae7b",
    "source_type" : 0,
    "tenant_id" : "27e25061336f4af590faeabeb7fcd9a3",
    "created_at" : "2017-11-18 07:54:21.665430",
    "id" : "5b95c675-69c2-4656-ba06-58ff72e1d338",
    "public_ip_address" : "10.15.10.11,10.15.10.12",
    "floating_ip_address" : "10.15.10.11,10.15.10.12",
    "description" : "my_snat_rule_update"
  }
}