Updating an SNAT Rule
Function
This API is used to update a specified SNAT rule.
Calling Method
For details, see Calling APIs.
URI
PUT /v3/{project_id}/private-nat/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 used to obtain 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. Minimum: 1 Maximum: 10240 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
snat_rule |
Yes |
UpdatePrivateSnatOption object |
Specifies the request body for updating an SNAT rule. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
transit_ip_ids |
No |
Array of strings |
Specifies the ID list of transit IP addresses. Minimum: 36 Maximum: 36 Array Length: 1 - 1 |
description |
No |
String |
Provides supplementary information about the SNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>). Minimum: 1 Maximum: 36 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID. Minimum: 36 Maximum: 36 |
snat_rule |
PrivateSnat object |
Specifies the response body of the SNAT rule. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the SNAT rule ID. Minimum: 36 Maximum: 36 |
project_id |
String |
Specifies the project ID. Minimum: 36 Maximum: 36 |
gateway_id |
String |
Specifies the private NAT gateway ID. Minimum: 36 Maximum: 36 |
cidr |
String |
Specifies the CIDR block that matches the SNAT rule. Constraints:
Minimum: 9 Maximum: 18 |
virsubnet_id |
String |
Specifies the ID of the subnet that matches the SNAT rule. Constraint: Either this parameter or cidr must be specified. Minimum: 36 Maximum: 36 |
description |
String |
Provides supplementary information about the SNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>). Minimum: 1 Maximum: 36 |
transit_ip_associations |
Array of AssociatedTransitIp objects |
Specifies the list of details of associated transit IP addresses. Array Length: 1 - 1 |
created_at |
String |
Specifies when the SNAT rule was created. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format. Minimum: 1 Maximum: 36 |
updated_at |
String |
Specifies when the SNAT rule was updated. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format. Minimum: 1 Maximum: 36 |
enterprise_project_id |
String |
Specifies the enterprise project ID. Minimum: 1 Maximum: 36 |
Example Requests
Updating an SNAT rule (Setting transit_ip_ids to bbe7c2e7-3bad-445b-a067-b30acce66053 and description to my_snat_rule_update)
PUT https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat/snat-rules/af4dbb83-7ca0-4ed1-b28b-668c1f9c6b81 { "snat_rule" : { "description" : "my_snat_rule_update", "transit_ip_ids" : [ "bbe7c2e7-3bad-445b-a067-b30acce66053" ] } }
Example Responses
Status code: 200
SNAT rule updated.
{ "request_id" : "15bd32b2-1464-4817-b559-444d22499f6c", "snat_rule" : { "id" : "af4dbb83-7ca0-4ed1-b28b-668c1f9c6b81", "project_id" : "cfa563efb77d4b6d9960781d82530fd8", "description" : "my_snat_rule_update", "gateway_id" : "80da6f26-94eb-4537-97f0-5a56f4d04cfb", "cidr" : "10.1.1.64/30", "virsubnet_id" : "", "transit_ip_associations" : [ { "transit_ip_id" : "bbe7c2e7-3bad-445b-a067-b30acce66053", "transit_ip_address" : "172.20.1.98" } ], "created_at" : "2019-10-22T03:31:19", "updated_at" : "2019-10-22T03:39:52" } }
SDK Sample Code
The SDK sample code is as follows.
Updating an SNAT rule (Setting transit_ip_ids to bbe7c2e7-3bad-445b-a067-b30acce66053 and description to my_snat_rule_update)
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 53 54 55 |
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.*; import java.util.List; import java.util.ArrayList; public class UpdatePrivateSnatSolution { 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(); UpdatePrivateSnatRequest request = new UpdatePrivateSnatRequest(); UpdatePrivateSnatOptionBody body = new UpdatePrivateSnatOptionBody(); List<String> listSnatRuleTransitIpIds = new ArrayList<>(); listSnatRuleTransitIpIds.add("bbe7c2e7-3bad-445b-a067-b30acce66053"); UpdatePrivateSnatOption snatRulebody = new UpdatePrivateSnatOption(); snatRulebody.withTransitIpIds(listSnatRuleTransitIpIds) .withDescription("my_snat_rule_update"); body.withSnatRule(snatRulebody); request.withBody(body); try { UpdatePrivateSnatResponse response = client.updatePrivateSnat(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()); } } } |
Updating an SNAT rule (Setting transit_ip_ids to bbe7c2e7-3bad-445b-a067-b30acce66053 and description to my_snat_rule_update)
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 |
# 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 = UpdatePrivateSnatRequest() listTransitIpIdsSnatRule = [ "bbe7c2e7-3bad-445b-a067-b30acce66053" ] snatRulebody = UpdatePrivateSnatOption( transit_ip_ids=listTransitIpIdsSnatRule, description="my_snat_rule_update" ) request.body = UpdatePrivateSnatOptionBody( snat_rule=snatRulebody ) response = client.update_private_snat(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Updating an SNAT rule (Setting transit_ip_ids to bbe7c2e7-3bad-445b-a067-b30acce66053 and description to my_snat_rule_update)
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 |
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.UpdatePrivateSnatRequest{} var listTransitIpIdsSnatRule = []string{ "bbe7c2e7-3bad-445b-a067-b30acce66053", } descriptionSnatRule:= "my_snat_rule_update" snatRulebody := &model.UpdatePrivateSnatOption{ TransitIpIds: &listTransitIpIdsSnatRule, Description: &descriptionSnatRule, } request.Body = &model.UpdatePrivateSnatOptionBody{ SnatRule: snatRulebody, } response, err := client.UpdatePrivateSnat(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 |
SNAT rule updated. |
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