Updated on 2024-04-19 GMT+08:00

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Minimum: 1

Maximum: 36

Request Parameters

Table 2 Request header 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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

dnat_rules

Yes

Array of CreateNatGatewayDnatOption objects

Specifies the request body for creating DNAT rules in batches.

Table 4 CreateNatGatewayDnatOption

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

Table 5 Response body parameters

Parameter

Type

Description

dnat_rules

Array of NatGatewayDnatRuleResponseBody objects

Specifies the response body for creating DNAT rules in batches.

Table 6 NatGatewayDnatRuleResponseBody

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:

  • ACTIVE

  • PENDING_CREATE

  • PENDING_UPDATE

  • PENDING_DELETE

  • EIP_FREEZED

  • INACTIVE

admin_state_up

Boolean

Specifies whether the DNAT rule is frozen. The value can be:

  • true: The DNAT rule is unfrozen.

  • false: The DNAT rule is frozen.

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:

  • tcp

  • udp

  • any

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"
  } ]
}

Status Codes

Status Code

Description

201

Normal response code for POST operations

Error Codes

See Error Codes.