Updating a DNAT Rule
Function
This API is used to update a DNAT rule.
Constraints
You can update a DNAT rule only when its status is set to ACTIVE and admin_state_up of the NAT gateway administrator to True. Specify either port_id or private_ip at a time. If you are going to update a DNAT rule that allows traffic to and from all ports of a server and an EIP, set internal_service_port to 0, external_service_port to 0, and protocol to ANY.The following fields must be updated together: port_id, private_ip, internal_service_port, external_service_port, floating_ip_id, protocol, internal_service_port_range, and external_service_port_range.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/dnat_rules/{dnat_rule_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
dnat_rule_id |
Yes |
String |
Specifies the DNAT rule ID. |
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 value. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dnat_rule |
Yes |
Specifies the request body for updating the DNAT rule. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
nat_gateway_id |
Yes |
String |
Specifies the NAT gateway ID. |
description |
No |
String |
Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>). |
port_id |
No |
String |
Specifies the port ID of an ECS or BMS. This parameter applies to VPC scenarios. Configure either port_id or private_ip. |
private_ip |
No |
String |
Specifies the private IP address of a user. This parameter applies to Direct Connect and Cloud Connect scenarios. Configure either private_ip or port_id. |
protocol |
No |
String |
Specifies the protocol. TCP, UDP, and ANY are supported. The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively. |
global_eip_id |
No |
String |
Specifies the global EIP ID. Configure either the EIP ID or the global EIP ID. |
floating_ip_id |
No |
String |
Specifies the EIP ID. |
internal_service_port |
No |
Integer |
Specifies the port used by ECSs or BMSs to provide services for external systems. Supported range: 0 to 65535 |
external_service_port |
No |
Integer |
Specifies the port used by the floating IP address to provide services for external systems. Supported range: 0 to 65535 |
internal_service_port_range |
No |
String |
Specifies the port range used by ECSs or BMSs to provide services for external systems. The number of ports must be the same as that of external _service_port_range. The value ranges from 1 to 65535. Specify two port numbers connected by a single hyphen (-) and no blank spaces in the x-y format, where x is lower than y. |
external_service_port_range |
No |
String |
Specifies the port range used by the floating IP address to provide services for external systems. The number of ports must be the same as that of internal _service_port_range. The value ranges from 1 to 65535. Specify two port numbers connected by a single hyphen (-) and no blank spaces in the x-y format, where x is lower than y. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
dnat_rule |
Specifies the response body of the DNAT rule. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the DNAT rule ID. |
tenant_id |
String |
Specifies the project ID. |
description |
String |
Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>). |
port_id |
String |
Specifies the port ID of an ECS or BMS. This parameter applies to VPC scenarios. Configure either port_id or private_ip. |
private_ip |
String |
Specifies the private IP address of a user. This parameter applies to Direct Connect and Cloud Connect scenarios. Configure either private_ip or port_id. |
internal_service_port |
Integer |
Specifies the port used by ECSs or BMSs to provide services for external systems. Supported range: 0 to 65535 |
nat_gateway_id |
String |
Specifies the public NAT gateway ID. |
global_eip_id |
String |
Specifies the global EIP ID. Configure either the EIP ID or the global EIP ID. |
global_eip_address |
String |
Specifies the global EIP. |
floating_ip_id |
String |
Specifies the EIP ID. |
floating_ip_address |
String |
Specifies the EIP address. |
external_service_port |
Integer |
Specifies the port used by the floating IP address to provide services for external systems. Supported range: 0 to 65535 |
status |
String |
Specifies the DNAT rule status. The value can be:
|
admin_state_up |
Boolean |
Specifies whether the DNAT rule is frozen. The value can be:
|
internal_service_port_range |
String |
Specifies the port range used by ECSs or BMSs to provide services for external systems. The number of ports must be the same as that of external _service_port_range. The value ranges from 1 to 65535. Specify two port numbers connected by a single hyphen (-) and no blank spaces in the x-y format, where x is lower than y. |
external_service_port_range |
String |
Specifies the port range used by the floating IP address to provide services for external systems. The number of ports must be the same as that of internal _service_port_range. The value ranges from 1 to 65535. Specify two port numbers connected by a single hyphen (-) and no blank spaces in the x-y format, where x is lower than y. |
protocol |
String |
Specifies the protocol. TCP, UDP, and ANY are supported. The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively. |
created_at |
Datetime |
Specifies when the DNAT rule was created. The time is in yyyy-mm-dd hh:mm:ss.SSSSSS format. |
Example Requests
PUT https://{NAT_endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/dnat_rules/79195d50-0271-41f1-bded-4c089b2502ff { "dnat_rule" : { "nat_gateway_id" : "a78fb3eb-1654-4710-8742-3fc49d5f04f8", "description" : "my dnat-rules" } }
Example Responses
Status code: 200
DNAT rule updated.
{ "dnat_rule" : { "status" : "ACTIVE", "nat_gateway_id" : "a78fb3eb-1654-4710-8742-3fc49d5f04f8", "admin_state_up" : true, "port_id" : "9a469561-daac-4c94-88f5-39366e5ea193", "internal_service_port" : 993, "protocol" : "tcp", "tenant_id" : "d199ba7e0ba64899b2e81518104b1526", "floating_ip_id" : "cf99c679-9f41-4dac-8513-9c9228e713e1", "created_at" : "2017-11-15 15:44:42.595173", "id" : "79195d50-0271-41f1-bded-4c089b2502ff", "floating_ip_address" : "5.21.11.226", "external_service_port" : 242, "description" : "my dnat rule" } }
SDK Sample Code
The SDK sample code is as follows.
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 |
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 UpdateNatGatewayDnatRuleSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); NatClient client = NatClient.newBuilder() .withCredential(auth) .withRegion(NatRegion.valueOf("<YOUR REGION>")) .build(); UpdateNatGatewayDnatRuleRequest request = new UpdateNatGatewayDnatRuleRequest(); request.withDnatRuleId("{dnat_rule_id}"); UpdateNatGatewayDnatRuleRequestBody body = new UpdateNatGatewayDnatRuleRequestBody(); UpdateNatGatewayDnatRuleOption dnatRulebody = new UpdateNatGatewayDnatRuleOption(); dnatRulebody.withNatGatewayId("a78fb3eb-1654-4710-8742-3fc49d5f04f8") .withDescription("my dnat-rules"); body.withDnatRule(dnatRulebody); request.withBody(body); try { UpdateNatGatewayDnatRuleResponse response = client.updateNatGatewayDnatRule(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()); } } } |
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 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = NatClient.new_builder() \ .with_credentials(credentials) \ .with_region(NatRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateNatGatewayDnatRuleRequest() request.dnat_rule_id = "{dnat_rule_id}" dnatRulebody = UpdateNatGatewayDnatRuleOption( nat_gateway_id="a78fb3eb-1654-4710-8742-3fc49d5f04f8", description="my dnat-rules" ) request.body = UpdateNatGatewayDnatRuleRequestBody( dnat_rule=dnatRulebody ) response = client.update_nat_gateway_dnat_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) |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := nat.NewNatClient( nat.NatClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateNatGatewayDnatRuleRequest{} request.DnatRuleId = "{dnat_rule_id}" descriptionDnatRule:= "my dnat-rules" dnatRulebody := &model.UpdateNatGatewayDnatRuleOption{ NatGatewayId: "a78fb3eb-1654-4710-8742-3fc49d5f04f8", Description: &descriptionDnatRule, } request.Body = &model.UpdateNatGatewayDnatRuleRequestBody{ DnatRule: dnatRulebody, } response, err := client.UpdateNatGatewayDnatRule(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 |
DNAT 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