Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Updating a DNAT Rule

Updated on 2022-01-25 GMT+08:00

Function

This API is used to update a DNAT rule.

NOTE:

You can update the rule only when status of the DNAT rule is set to ACTIVE and admin_state_up of the NAT gateway administrator to True. Either port_id or private_ip is used each time. If you create a rule that applies to all port types, set internal_service_port to 0, external_service_port to 0, and protocol to ANY.

The fields, including port_id, private_ip, internal_service_port, external_service_port, floating_ip_id, protocol, internal_service_port_range, and external_service_port_range must be updated together.

URI

PUT /v2/{project_id}/dnat_rules/{dnat_rule_id}

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

dnat_rule_id

Yes

String

Specifies the DNAT rule ID.

Request

Table 3 describes the request parameters.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

dnat_rule

Yes

Object

Specifies the DNAT rule object. For details, see Table 3.

Table 3 Description of the dnat_rule field

Parameter

Mandatory

Type

Description

nat_gateway_id

Yes

String

Specifies the NAT gateway ID.

port_id

No

String

Specifies the port ID of an ECS or a BMS. This parameter and private_ip are alternative.

private_ip

No

String

Specifies the private IP address of a user, for example, the IP address of a VPC for Direct Connect connection. This parameter and port_id are alternative.

internal_service_port

No

Integer

Specifies the port used by ECSs or BMSs to provide services for external systems.

floating_ip_id

No

String

Specifies the EIP ID.

external_service_port

No

Integer

Specifies the port for providing external services.

protocol

No

String

Specifies the protocol type. Currently, TCP, UDP, and ANY are supported.

The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.

description

No

String(255)

Provides supplementary information about the DNAT rule.

internal_service_port_range

No

String

Specifies the port range used by ECSs or BMSs to provide services for external systems.

  • The port range is the same as the value of external _service_port_range.
  • The value ranges from 1 to 65535.
  • Specify two port numbers separated by a single hyphen (-) and no blank spaces in the format, x-y, where x is lower than y.

external_service_port_range

No

String

Specifies the port range used by the floating IP address for providing external services.

  • The port range is the same as the value of internal _service_port_range.
  • The value ranges from 1 to 65535.
  • Specify two port numbers separated by a single hyphen (-) and no blank spaces in the format, x-y, where x is lower than y.

Response

Table 4 lists response parameters.

Table 4 Response parameter

Parameter

Type

Description

dnat_rule

Object

Specifies the DNAT rule object.

Table 5 Description of the dnat_rule field

Parameter

Type

Description

id

String

Specifies the DNAT rule ID.

tenant_id

String

Specifies the project ID.

nat_gateway_id

String

Specifies the NAT gateway ID.

port_id

String

Specifies the port ID of an ECS or a BMS.

private_ip

String

Specifies the private IP address of a user, for example, the IP address of a VPC for Direct Connect connection.

internal_service_port

Integer

Specifies the port used by ECSs or BMSs to provide services for external systems.

floating_ip_id

String

Specifies the EIP ID.

floating_ip_address

String

Specifies the EIP.

external_service_port

Integer

Specifies the port for providing external services.

protocol

String

Specifies the protocol type. Currently, TCP, UDP, and ANY are supported.

The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.

description

String(255)

Provides supplementary information about the DNAT rule.

status

String

  • Specifies the status of the DNAT rule.
  • For details about all its values, see Table 1.

admin_state_up

Boolean

  • Specifies the unfrozen or frozen state.
  • The value can be:
    • true: indicates the unfrozen state.
    • false: indicates the frozen state.

created_at

String

  • Specifies when the DNAT rule is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

internal_service_port_range

String

Specifies the port range used by ECSs or BMSs to provide services for external systems.

  • The port range is the same as the value of external _service_port_range.
  • The value ranges from 1 to 65535.

external_service_port_range

String

Specifies the port range used by the floating IP address for providing external services.

  • The port range is the same as the value of internal _service_port_range.
  • The value ranges from 1 to 65535.

Example

  • Example request
    1. Update a rule to apply to a specific port.
      PUT https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/dnat_rules/79195d50-0271-41f1-bded-4c089b2502ff
      { 
           "dnat_rule": { 
               "nat_gateway_id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8",
               "floating_ip_id": "cf99c679-9f41-4dac-8513-9c9228e713e1", 
               "port_id": "9a469561-daac-4c94-88f5-39366e5ea193", 
               "internal_service_port": 993, 
               "protocol": "tcp", 
               "external_service_port": 242, 
               "description": "my dnat rule 01"
           } 
       }
    2. Update a rule to apply to all ports.
      PUT https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/dnat_rules/79195d50-0271-41f1-bded-4c089b2502ff
      { 
           "dnat_rule": { 
               "nat_gateway_id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8",
               "floating_ip_id": "bf99c679-9f41-4dac-8513-9c9228e713e1",
               "private_ip": "192.168.1.100", 
               "internal_service_port": 0, 
               "protocol": "any", 
               "external_service_port": 0, 
              "description": "my dnat rule 01" 
           } 
       }
    3. Update the port range of a rule.
      PUT https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/dnat_rules/79195d50-0271-41f1-bded-4c089b2502ff
      { 
           "dnat_rule": { 
               "nat_gateway_id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8",
               "floating_ip_id": "bf99c679-9f41-4dac-8513-9c9228e713e1",
               "private_ip": "192.168.1.100", 
               "internal_service_port": 0, 
               "protocol": "tcp", 
               "external_service_port": 0, 
               "description": "my dnat rule 01" ,
               "external_service_port_range":"100-200",
               "internal_service_port_range":"100-200"
           } 
       }
    4. Update the description of a rule.
      PUT https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/dnat_rules/79195d50-0271-41f1-bded-4c089b2502ff
      { 
           "dnat_rule": { 
              "nat_gateway_id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8",
              "description": "my dnat rule 01"
           } 
      }
  • Example response
    1. Response to update a rule that applies to a specific port
      { 
           "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": "abc", 
               "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 01" 
           } 
       }
    2. Response to update a rule that applies to all ports
      { 
           "dnat_rule": { 
               "status": "ACTIVE", 
               "nat_gateway_id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8", 
               "admin_state_up": true, 
               "private_ip": "192.168.1.100", 
               "internal_service_port": 0, 
               "protocol": "any", 
               "tenant_id": "abc", 
               "floating_ip_id": "bf99c679-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.227", 
               "external_service_port": 0, 
               "description": "my dnat rule 01" 
           } 
       }
    3. Response to update the port range of a rule
      { 
           "dnat_rule": { 
               "status": "ACTIVE", 
               "nat_gateway_id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8", 
               "admin_state_up": true, 
               "private_ip": "192.168.1.100", 
               "internal_service_port": 0, 
               "protocol": "tcp", 
               "tenant_id": "abc", 
               "floating_ip_id": "bf99c679-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.227", 
               "external_service_port": 0, 
               "description": "my dnat rule 01",
               "internal_service_port_range": "100-200",
               "external_service_port_range": "100-200"
           } 
       }
    4. Response to update the description of a rule
      { 
           "dnat_rule": { 
               "status": "ACTIVE", 
               "nat_gateway_id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8", 
               "admin_state_up": true, 
               "port_id": "9a469561-daac-4c94-88f5-39366e5ea193", 
               "private_ip": "",
               "internal_service_port": 993, 
               "protocol": "tcp", 
               "tenant_id": "abc", 
               "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 01" 
           } 
       }

Status Code

See Status Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback