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}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. Minimum: 1 Maximum: 36 |
snat_rule_id |
Yes |
String |
Specifies the SNAT rule ID. Minimum: 36 Maximum: 36 |
Request 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. Minimum: 1 Maximum: 10240 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
snat_rule |
Yes |
Specifies the request body for updating the SNAT rule. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
nat_gateway_id |
Yes |
String |
Specifies the public NAT gateway ID. Minimum: 36 Maximum: 36 |
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 (<>). Minimum: 0 Maximum: 255 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
snat_rule |
Specifies the response body for updating the SNAT rule. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the SNAT rule ID. Minimum: 36 Maximum: 36 |
tenant_id |
String |
Specifies the project ID. Minimum: 1 Maximum: 36 |
nat_gateway_id |
String |
Specifies the public NAT gateway ID. Minimum: 36 Maximum: 36 |
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. Minimum: 0 Maximum: 1 Default: 0 |
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 on-premises servers connected to the VPC through Direct Connect or Cloud Connect. Minimum: 9 Maximum: 18 |
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 (<>). Minimum: 0 Maximum: 255 |
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. Enumeration values:
|
created_at |
String |
Specifies when the SNAT rule was created. The time is in yyyy-mm-dd hh:mm:ss.SSSSSS format. Minimum: 1 Maximum: 36 |
network_id |
String |
Specifies the network ID used by the SNAT rule. Configure either network_id or cidr. Minimum: 36 Maximum: 36 |
admin_state_up |
Boolean |
Specifies whether the SNAT rule is frozen. The value can be:
|
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 address. |
global_eip_id |
String |
Specifies the global EIP ID. |
Example Requests
Specifies the request body for updating the SNAT rule.
PUT https://{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" : "ACTIVE", "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" } }
SDK Sample Code
The SDK sample code is as follows.
Specifies the request body for updating the SNAT rule.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.nat.v2.region.NatRegion; import com.huaweicloud.sdk.nat.v2.*; import com.huaweicloud.sdk.nat.v2.model.*; public class UpdateNatGatewaySnatRuleSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); NatClient client = NatClient.newBuilder() .withCredential(auth) .withRegion(NatRegion.valueOf("<YOUR REGION>")) .build(); UpdateNatGatewaySnatRuleRequest request = new UpdateNatGatewaySnatRuleRequest(); UpdateNatGatewaySnatRuleRequestOption body = new UpdateNatGatewaySnatRuleRequestOption(); UpdateNatGatewaySnatRuleOption snatRulebody = new UpdateNatGatewaySnatRuleOption(); snatRulebody.withNatGatewayId("bbe7c2e7-3bad-445b-a067-b30acce66053") .withPublicIpAddress("10.15.10.11,10.15.10.12") .withDescription("my_snat_rule_update"); body.withSnatRule(snatRulebody); request.withBody(body); try { UpdateNatGatewaySnatRuleResponse response = client.updateNatGatewaySnatRule(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Specifies the request body for updating the SNAT rule.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdknat.v2.region.nat_region import NatRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdknat.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = NatClient.new_builder() \ .with_credentials(credentials) \ .with_region(NatRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateNatGatewaySnatRuleRequest() snatRulebody = UpdateNatGatewaySnatRuleOption( nat_gateway_id="bbe7c2e7-3bad-445b-a067-b30acce66053", public_ip_address="10.15.10.11,10.15.10.12", description="my_snat_rule_update" ) request.body = UpdateNatGatewaySnatRuleRequestOption( snat_rule=snatRulebody ) response = client.update_nat_gateway_snat_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Specifies the request body for updating the SNAT rule.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" nat "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := nat.NewNatClient( nat.NatClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateNatGatewaySnatRuleRequest{} publicIpAddressSnatRule:= "10.15.10.11,10.15.10.12" descriptionSnatRule:= "my_snat_rule_update" snatRulebody := &model.UpdateNatGatewaySnatRuleOption{ NatGatewayId: "bbe7c2e7-3bad-445b-a067-b30acce66053", PublicIpAddress: &publicIpAddressSnatRule, Description: &descriptionSnatRule, } request.Body = &model.UpdateNatGatewaySnatRuleRequestOption{ SnatRule: snatRulebody, } response, err := client.UpdateNatGatewaySnatRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Normal response to PUT requests |
Error Codes
See Error 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