Creating DNAT Rules in Batches
Function
This API is used to create DNAT rules in batches.
Constraints
You can create DNAT rules in batches only when status of the NAT gateway is ACTIVE and admin_state_up of the NAT gateway administrator is True. Specify either port_id or private_ip at a time. If you are going to batch create DNAT rules (each 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.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/dnat_rules/batch
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. Minimum: 1 Maximum: 36 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
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 |
---|---|---|---|
dnat_rules |
Yes |
Array of CreateNatGatewayDnatOption objects |
Specifies the request body for creating DNAT rules in batches. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
description |
No |
String |
Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>). Minimum: 0 Maximum: 255 |
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. Minimum: 36 Maximum: 36 |
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. Minimum: 7 Maximum: 15 |
nat_gateway_id |
Yes |
String |
Specifies the public NAT gateway ID. Minimum: 36 Maximum: 36 |
internal_service_port |
Yes |
Integer |
Specifies the port used by ECSs or BMSs to provide services for external systems. Supported range: 0 to 65535 Minimum: 0 Maximum: 65535 |
floating_ip_id |
Yes |
String |
Specifies the EIP ID. Minimum: 36 Maximum: 36 |
external_service_port |
Yes |
Integer |
Specifies the port used by the floating IP address to provide services for external systems. Supported range: 0 to 65535 Minimum: 0 Maximum: 65535 |
protocol |
Yes |
String |
Specifies the protocol. TCP, UDP, and ANY are supported. The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively. |
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. Supported range: 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. Supported range: 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. |
global_eip_id |
No |
String |
Specifies the global EIP ID. Minimum: 36 Maximum: 36 |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
dnat_rules |
Array of NatGatewayDnatRuleResponseBody objects |
Specifies the response body for creating DNAT rules in batches. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the DNAT rule ID. Minimum: 36 Maximum: 36 |
tenant_id |
String |
Specifies the project ID. Minimum: 1 Maximum: 36 |
description |
String |
Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>). Minimum: 0 Maximum: 255 |
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. Minimum: 36 Maximum: 36 |
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. Minimum: 7 Maximum: 15 |
internal_service_port |
Integer |
Specifies the port used by ECSs or BMSs to provide services for external systems. Supported range: 0 to 65535 Minimum: 0 Maximum: 65535 Minimum: 1 Maximum: 5 |
nat_gateway_id |
String |
Specifies the public NAT gateway ID. Minimum: 1 Maximum: 36 |
floating_ip_id |
String |
Specifies the EIP ID. Minimum: 1 Maximum: 36 |
floating_ip_address |
String |
Specifies the EIP address. Minimum: 7 Maximum: 15 |
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: ACTIVE: The DNAT rule is available. PENDING_CREATE: The DNAT rule is being created. PENDING_UPDATE: The DNAT rule is being updated. PENDING_DELETE: The DNAT rule is being deleted. EIP_FREEZED: The EIP is frozen. INACTIVE: The DNAT rule is unavailable. Enumeration values:
|
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. Supported range: 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. Supported range: 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. Minimum: 1 Maximum: 3 Enumeration values:
|
created_at |
String |
Specifies when the DNAT rule was created. The time is in yyyy-mm-dd hh:mm:ss.SSSSSS format. Minimum: 1 Maximum: 36 |
global_eip_id |
String |
Specifies the global EIP ID. Minimum: 36 Maximum: 36 |
global_eip_address |
String |
Specifies the global EIP address. Minimum: 7 Maximum: 15 |
Example Requests
Creating DNAT rules in batches (In the first DNAT rule, both internal_service_port and external_service_port are set to a specific port number. In the second DNAT rule, both internal_service_port and external_service_port are set to 0.)
POST https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/dnat_rules/batch { "dnat_rules" : [ { "floating_ip_id" : "bf99c679-9f41-4dac-8513-9c9228e713e1", "nat_gateway_id" : "cda3a125-2406-456c-a11f-598e10578541", "port_id" : "9a469561-daac-4c94-88f5-39366e5ea193", "internal_service_port" : 993, "protocol" : "tcp", "external_service_port" : 242, "description" : "my dnat rule 01" }, { "floating_ip_id" : "cf99c679-9f41-4dac-8513-9c9228e713e1", "nat_gateway_id" : "dda3a125-2406-456c-a11f-598e10578541", "private_ip" : "192.168.1.100", "internal_service_port" : 0, "protocol" : "any", "external_service_port" : 0, "description" : "my dnat rule 01" } ] }
Example Responses
Status code: 201
Normal response code for POST operations
{ "dnat_rules" : [ { "floating_ip_id" : "bf99c679-9f41-4dac-8513-9c9228e713e1", "status" : "PENDING_CREATE", "nat_gateway_id" : "cda3a125-2406-456c-a11f-598e10578541", "admin_state_up" : true, "port_id" : "9a469561-daac-4c94-88f5-39366e5ea193", "private_ip" : "", "internal_service_port" : 993, "protocol" : "tcp", "tenant_id" : "d199ba7e0ba64899b2e81518104b1526", "created_at" : "2019-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 01" }, { "floating_ip_id" : "cf99c679-9f41-4dac-8513-9c9228e713e1", "status" : "PENDING_CREATE", "nat_gateway_id" : "dda3a125-2406-456c-a11f-598e10578541", "admin_state_up" : true, "port_id" : "", "private_ip" : "192.168.1.100", "internal_service_port" : 0, "protocol" : "any", "tenant_id" : "d199ba7e0ba64899b2e81518104b1526", "created_at" : "2019-11-15 15:44:42.595173", "id" : "79195d50-0271-41f1-bded-4c089c2502ff", "floating_ip_address" : "5.21.11.227", "external_service_port" : 0, "description" : "my dnat rule 01" } ] }
SDK Sample Code
The SDK sample code is as follows.
Creating DNAT rules in batches (In the first DNAT rule, both internal_service_port and external_service_port are set to a specific port number. In the second DNAT rule, both internal_service_port and external_service_port are set to 0.)
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 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
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 BatchCreateNatGatewayDnatRulesSolution { 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(); BatchCreateNatGatewayDnatRulesRequest request = new BatchCreateNatGatewayDnatRulesRequest(); BatchCreateNatGatewayDnatRulesRequestBody body = new BatchCreateNatGatewayDnatRulesRequestBody(); List<CreateNatGatewayDnatOption> listbodyDnatRules = new ArrayList<>(); listbodyDnatRules.add( new CreateNatGatewayDnatOption() .withDescription("my dnat rule 01") .withPortId("9a469561-daac-4c94-88f5-39366e5ea193") .withNatGatewayId("cda3a125-2406-456c-a11f-598e10578541") .withInternalServicePort(993) .withFloatingIpId("bf99c679-9f41-4dac-8513-9c9228e713e1") .withExternalServicePort(242) .withProtocol("tcp") ); listbodyDnatRules.add( new CreateNatGatewayDnatOption() .withDescription("my dnat rule 01") .withPrivateIp("192.168.1.100") .withNatGatewayId("dda3a125-2406-456c-a11f-598e10578541") .withInternalServicePort(0) .withFloatingIpId("cf99c679-9f41-4dac-8513-9c9228e713e1") .withExternalServicePort(0) .withProtocol("any") ); body.withDnatRules(listbodyDnatRules); request.withBody(body); try { BatchCreateNatGatewayDnatRulesResponse response = client.batchCreateNatGatewayDnatRules(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()); } } } |
Creating DNAT rules in batches (In the first DNAT rule, both internal_service_port and external_service_port are set to a specific port number. In the second DNAT rule, both internal_service_port and external_service_port are set to 0.)
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 |
# 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 = BatchCreateNatGatewayDnatRulesRequest() listDnatRulesbody = [ CreateNatGatewayDnatOption( description="my dnat rule 01", port_id="9a469561-daac-4c94-88f5-39366e5ea193", nat_gateway_id="cda3a125-2406-456c-a11f-598e10578541", internal_service_port=993, floating_ip_id="bf99c679-9f41-4dac-8513-9c9228e713e1", external_service_port=242, protocol="tcp" ), CreateNatGatewayDnatOption( description="my dnat rule 01", private_ip="192.168.1.100", nat_gateway_id="dda3a125-2406-456c-a11f-598e10578541", internal_service_port=0, floating_ip_id="cf99c679-9f41-4dac-8513-9c9228e713e1", external_service_port=0, protocol="any" ) ] request.body = BatchCreateNatGatewayDnatRulesRequestBody( dnat_rules=listDnatRulesbody ) response = client.batch_create_nat_gateway_dnat_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Creating DNAT rules in batches (In the first DNAT rule, both internal_service_port and external_service_port are set to a specific port number. In the second DNAT rule, both internal_service_port and external_service_port are set to 0.)
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 56 57 58 59 60 61 62 |
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.BatchCreateNatGatewayDnatRulesRequest{} descriptionDnatRules:= "my dnat rule 01" portIdDnatRules:= "9a469561-daac-4c94-88f5-39366e5ea193" descriptionDnatRules1:= "my dnat rule 01" privateIpDnatRules:= "192.168.1.100" var listDnatRulesbody = []model.CreateNatGatewayDnatOption{ { Description: &descriptionDnatRules, PortId: &portIdDnatRules, NatGatewayId: "cda3a125-2406-456c-a11f-598e10578541", InternalServicePort: int32(993), FloatingIpId: "bf99c679-9f41-4dac-8513-9c9228e713e1", ExternalServicePort: int32(242), Protocol: "tcp", }, { Description: &descriptionDnatRules1, PrivateIp: &privateIpDnatRules, NatGatewayId: "dda3a125-2406-456c-a11f-598e10578541", InternalServicePort: int32(0), FloatingIpId: "cf99c679-9f41-4dac-8513-9c9228e713e1", ExternalServicePort: int32(0), Protocol: "any", }, } request.Body = &model.BatchCreateNatGatewayDnatRulesRequestBody{ DnatRules: listDnatRulesbody, } response, err := client.BatchCreateNatGatewayDnatRules(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 |
---|---|
201 |
Normal response code for POST operations |
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