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}
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.
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
snat_rule |
Yes |
Object |
Specifies the SNAT rule object. For details, see Table 3. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
nat_gateway_id |
Yes |
String |
Specifies the NAT gateway ID. |
public_ip_address |
No |
String(1024) |
|
description |
No |
String(255) |
Provides supplementary information about the SNAT rule. |
Response
Table 4 lists response parameters.
Parameter |
Type |
Description |
---|---|---|
snat_rule |
Object |
Specifies the SNAT rule object. |
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) |
|
description |
String(255) |
Provides supplementary information about the SNAT rule. |
status |
String |
|
admin_state_up |
Boolean |
|
created_at |
String |
|
public_ip_address |
String(1024) |
|
floating_ip_address |
String(1024) |
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot