Adding a DNAT Rule

Function

This API is used to add a DNAT rule.

Constraints

When you are adding a DNAT rule, status of the NAT gateway must be set to ACTIVE.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
nat:privateNatDnatRules:create	Write	privateGateway *	g:ResourceTag/<tag-key>	-	-
		privateDnatRule *	-
		privateTransitIp *	g:ResourceTag/<tag-key>
		port	-
		-	g:EnterpriseProjectId

URI

POST /v3/{project_id}/private-nat/dnat-rules

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

Request Parameters

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
dnat_rule	Yes	CreatePrivateDnatOption object	Specifies the request body for adding a DNAT rule.

**Table 4** CreatePrivateDnatOption
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 (<>).
transit_ip_id	Yes	String	Specifies the ID of the transit IP address.
network_interface_id	No	String	Specifies the port ID of the resource that the NAT gateway is bound to. The resource can be a compute instance, load balancer (v2 or v3), or virtual IP address. Note: Either this parameter or private_ip_address must be specified. Otherwise, an error will be reported.
gateway_id	Yes	String	Specifies the private NAT gateway ID.
protocol	No	String	Specifies the protocol type. TCP, UDP, and ANY are supported. The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.
private_ip_address	No	String	Specifies the port IP address that the NAT gateway uses. The resource can be a compute instance, load balancer (v2 or v3), or virtual IP address. Note: Either this parameter or network_interface_id must be specified. Otherwise, an error will be reported.
internal_service_port	No	String	Specifies the port number of the resource, which can be a compute instance, load balancer (v2 or v3), or virtual IP address.
transit_service_port	No	String	Specifies the port number of the transit IP address.

Response Parameters

Status code: 201

**Table 5** Response body parameters
Parameter	Type	Description
dnat_rule	PrivateDnat object	Specifies the response body of the DNAT rule.
request_id	String	Specifies the request ID.

**Table 6** PrivateDnat
Parameter	Type	Description
id	String	Specifies the DNAT rule ID.
project_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 (<>).
transit_ip_id	String	Specifies the ID of the transit IP address.
transit_ip_address	String	Specifies the transit IP address.
gateway_id	String	Specifies the private NAT gateway ID.
network_interface_id	String	Specifies the network interface ID. Network interfaces of a compute instance, load balancer (v2 or v3), or virtual IP address are supported.
type	String	Specifies the backend resource type of the DNAT rule. Options: COMPUTE: The backend resource is a compute instance. VIP: The backend resource is a virtual IP address. ELB: The backend resource is a v2 load balancer. ELBv3: The backend resource is a v3 load balancer. CUSTOMIZE: The backend resource is a user-defined IP address.
protocol	String	Specifies the protocol type. TCP, UDP, and ANY are supported. The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.
private_ip_address	String	Specifies the port IP address that the NAT gateway uses. The resource can be a compute instance, load balancer (v2 or v3), or virtual IP address.
internal_service_port	String	Specifies the port number of the resource, which can be a compute instance, load balancer (v2 or v3), or virtual IP address.
transit_service_port	String	Specifies the port number of the transit IP address.
enterprise_project_id	String	Specifies the ID of the enterprise project that is associated with the DNAT rule when the DNAT rule is created.
created_at	String	Specifies the time when the DNAT rule was added. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.
updated_at	String	Specifies the time when the DNAT rule was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.
status	String	Specifies the DNAT rule status of a private NAT gateway. The value can be: ACTIVE: The DNAT rule is active. FROZEN: The DNAT rule is frozen. INACTIVE: The DNAT rule is unavailable.

Example Requests

Adding a DNAT rule with the transit IP address ID set to 3faa719d-6d18-4ccb-a5c7-33e65a09663e, the private NAT gateway ID set to 0adefb29-a6c2-48a5-8637-2be67fa03fec, and network interface ID set to dae9393a-b536-491c-a5a2-72edc1104707

POST https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/dnat-rules

{
  "dnat_rule" : {
    "description" : "aa",
    "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec",
    "transit_ip_id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
    "network_interface_id" : "dae9393a-b536-491c-a5a2-72edc1104707"
  }
}

Example Responses

Status code: 201

DNAT rule added.

{
  "dnat_rule" : {
    "id" : "24dd6bf5-48f2-4915-ad0b-5bb111d39c83",
    "project_id" : "da261828016849188f4dcc2ef94d9da9",
    "description" : "aa",
    "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec",
    "transit_ip_id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
    "transit_ip_address" : "10.0.0.110",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "network_interface_id" : "dae9393a-b536-491c-a5a2-72edc1104707",
    "type" : "COMPUTE",
    "protocol" : "any",
    "internal_service_port" : "0",
    "transit_service_port" : "0",
    "private_ip_address" : "192.168.1.72",
    "created_at" : "2019-04-29T07:10:01",
    "updated_at" : "2019-04-29T07:10:01",
    "status" : "ACTIVE"
  },
  "request_id" : "70505c941b9b4dfd82fd351932328a2f"
}