Help Center> NAT Gateway> API Reference> API v2> SNAT Rules> Updating an SNAT Rule
View PDF

Updating an SNAT Rule

Function

This API is used to update an SNAT rule.

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

URI

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

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

snat_rule_id

Yes

String

Specifies the SNAT rule ID.

Request

Table 2 describes the request parameters.

Table 2 Request parameters

Parameter

Mandatory

Type

Description

snat_rule

Yes

Object

Specifies the SNAT rule object. For details, see Table 3.
Table 3 Description of the snat_rule field

Parameter

Mandatory

Type

Description

nat_gateway_id

Yes

String

Specifies the NAT gateway ID.

public_ip_address

No

String(1024)
  • Specifies the EIP. Multiple EIPs are separated using commas (,).
  • The maximum length is 1024 bytes.
  • The number of EIPs cannot exceed 20.
  • For details about how to obtain the EIP, see Querying EIPs.

description

No

String(255)

Provides supplementary information about the SNAT rule.

Response

Table 4 lists response parameters.

Table 4 Response parameter

Parameter

Type

Description

snat_rule

Object

Specifies the SNAT rule object.
Table 5 Description of the snat_rule field

Parameter

Type

Description

id

String

Specifies the SNAT rule ID.

tenant_id

String

Specifies the project ID.

nat_gateway_id

String

Specifies the NAT gateway ID.

network_id

String

Specifies the network ID used by the SNAT rule.

cidr

String

Specifies a subset of the VPC subnet CIDR block or a CIDR block of Direct Connect connection.

source_type

Integer

0: Either network_id or cidr can be specified in a VPC.

1: Only cidr can be specified over a Direct Connect connection.

If no value is entered, the default value 0 (VPC) is used.

floating_ip_id

String(4096)
  • Specifies the EIP ID. Multiple EIPs are separated using commas (,).
  • The maximum length of the ID is 4096 bytes.

description

String(255)

Provides supplementary information about the SNAT rule.

status

String
  • Specifies the status of the SNAT rule.
  • For details about all its values, see Table 1.

admin_state_up

Boolean
  • Specifies the unfrozen or frozen state.
  • The value can be:
    • true: indicates the unfrozen state.
    • false: indicates the frozen state.

created_at

String
  • Specifies when the SNAT rule is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

public_ip_address

String(1024)
  • Specifies the EIP. Multiple EIPs are separated using commas (,).
  • The maximum length is 1024 bytes.

floating_ip_address

String(1024)
  • Specifies the frozen EIP. Multiple EIPs are separated using commas (,).
  • The maximum length is 1024 bytes.

Example

  • Example request 
    PUT https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/snat_rules/5b95c675-69c2-4656-ba06-58ff72e1d338 
 { 
     "snat_rule": { 
         "nat_gateway_id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8", 
         "description": "my snat rule 01", 
         "public_ip_address": "10.15.10.11,10.15.10.12" 
     } 
 }
  • Example response 
    { 
     "snat_rule": { 
         "floating_ip_id": " bdc10a4c-d81a-41ec-adf7-de857f7c812a,7a094014-9657-463f-972b-e84d56b931a0", 
         "status": "PENDING_UPDATE", 
         "nat_gateway_id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8", 
         "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": "",
         "description": "my snat rule 01" 
     } 
 }

Status Code

See Status Codes.

Parent topic: SNAT Rules