华为乾坤-创建动态NAT策略:响应参数

时间:2025-02-17 11:36:38

响应参数

返回状态码为200:创建成功,响应体参考NatResponse。

表4 NatResponse对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

errcode

string

0~64个字符。

-

错误码。

"0"

errmsg

string

0~512个字符。

-

错误信息。

""

data

REFERENCE

详细请参见表5

详细的返回信息。

-

表5 DetailNatResponseInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

dynamicNatInfo

ARRAY_REFERENCE

0-1024个列表项,详细请参见表6

动态NAT的详细返回信息。

-

staticNatInfo

ARRAY_REFERENCE

0-1024个列表项,详细请参见表8

静态NAT的详细返回信息。

-

表6 DynamicNatDetailModel对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

policyId

string

0~64个字符。

-

策略ID,创建时不需要填写。

"00000000-0000-0000-0000-000000000000"

isOverlay

boolean

  • true

  • false

-

是否Overlay NAT。

true:Overlay NAT;

false,Underlay NAT。

true

vpnId

string

0~64个字符。

-

VPN业务ID。

Overlay NAT,填写WAN虚拟网络ID;

Underlay NAT,填写“UnderlayId”。

"00000000-0000-0000-0000-000000000000"

siteId

string

0~64个字符。

-

站点ID。

"00000000-0000-0000-0000-000000000000"

deviceId

string

0~64个字符。

-

部署动态NAT策略的CPE设备的ID。

"00000000-0000-0000-0000-000000000000"

policyName

string

0~64个字符。

-

策略名称,创建时必填。

"policyName"

linkId

string

0~64个字符。

-

使能NAT策略的接口ID。

Overlay NAT,填写LAN侧接口ip-subnet ID,如果在所有的Tunnel口上做NAT转换,填写"Overlay Tunnel"。

Underlay NAT,填写设备WAN链路的tnpId。

"00000000-0000-0000-0000-000000000000"

interfaceName

string

0~64个字符。

-

接口名称,创建修改不需要填写,查询返回。

"GE0/0/8"

natMode

string

  • EASY_IP

  • PAT

  • NO_PAT

-

NAT模式,该字段可以设置为以下几种:

a) EASY_IP:使用接口的地址作为NAT转换后的地址;

b) PAT:支持端口转换,地址转换为多对一;

c) NO_PAT:不支持端口转换,进行一对一的地址转换。

"EASY_IP"

startAddress

string

0~20个字符。

-

开始地址,NAT转换后的IP的范围,仅当NAT模式选择PAT或者No-PAT时,才可配置。

约束:

a) 结束IP必须大于或等于起始IP;

b) 地址范围不能超过255;

c) 同一接口下,不同NAT策略的IP段不能重叠。

"192.168.1.1"

endAddress

string

0~20个字符。

-

结束地址,约束同开始地址。

"192.168.1.2"

natRuleInfos

ARRAY_REFERENCE

0-100个列表项,详细请参见表7

规则信息。

-

表7 NatRuleModel对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

ruleId

string

0~64个字符。

-

规则id,创建时不填写。

"00000000-0000-0000-0000-000000000000"

priority

int32

[1-100]

-

优先级,范围:1(高)-100(低)。

1

action

string

  • permit

  • deny

-

动作,该字段可以设置为以下几种:

a) permit:允许

b) deny:拒绝

"permit"

protocol

int32

[0-255]

-

ACL规则匹配报文的协议类型。

常用协议类型:0:IP;1:ICMP;2:IGMP;4:IPinIP;6:TCP;17:UDP;47:GRE;89:OSPF。

6

sourceIp

string

0~20个字符。

-

ACL规则匹配报文的源IP网段。

"10.1.0.1/16"

destinationIp

string

0~20个字符。

-

ACL规则匹配报文的目的IP网段。

"10.2.0.1/16"

sourcePort

int32

[0-65535]

-

ACL规则匹配报文的源端口。

仅当协议选择为TCP或者UDP时,才可配置。

1

destinationPort

int32

[0-65535]

-

ACL规则匹配报文的目的IP端口。

仅当协议选择为TCP或者UDP时,才可配置。

1

表8 StaticNatDetailModel对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

policyId

string

0~64个字符。

-

策略id。

创建时不需要填写。

"00000000-0000-0000-0000-000000000000"

isOverlay

boolean

  • true

  • false

-

是否Overlay NAT。

true:Overlay NAT;

false,Underlay NAT。

true

vpnId

string

0~64个字符。

-

VPN业务ID。

Overlay NAT,填写WAN虚拟网络ID;

Underlay NAT,填写“UnderlayId”。

"00000000-0000-0000-0000-000000000000"

siteId

string

0~64个字符。

-

站点ID。

"00000000-0000-0000-0000-000000000000"

deviceId

string

0~64个字符。

-

部署静态NAT策略的CPE设备的ID。

"00000000-0000-0000-0000-000000000000"

policyName

string

0~64个字符。

-

静态NAT策略的名称,创建时必填。

"policyName"

linkId

string

0~64个字符。

-

使能NAT策略的接口ID。

Overlay NAT,填写LAN侧接口ip-subnet ID,如果在所有的Tunnel口上做NAT转换,填写"Overlay Tunnel"。

Underlay NAT,填写设备WAN链路的tnpId。

"00000000-0000-0000-0000-000000000000"

interfaceName

string

0~64个字符。

-

接口名称,创建修改不需要填写,查询返回。

"GE0/0/8"

isUserDefined

boolean

  • true

  • false

-

是否用户自定义外部IP。

true,用户自定义;

false,使用当前接口IP。

true

externalIp

string

0~20个字符。

-

外部IP,NAT转换后的IP,一般是公网IP。

"10.2.0.1"

internalIp

string

0~20个字符。

-

内部IP,NAT转换前的IP,一般是私网IP。

"10.1.0.1"

translationType

int32

[0-1]

-

转换类型,该字段可以设置为以下几种:

a) 0:地址转换

b) 1:协议转换

当isUserDefined为false时,只能填写1。

1

protocol

string

0~10个字符。

-

协议,该字段可以设置为以下几种:

a) 0:TCP

b) 1:UDP

c) 2:ICMP

"1"

externalPort

int32

[0-65535]

-

外部端口,NAT转换后的端口号。

90

internalPort

int32

[0-65535]

-

内部端口,NAT转换前的端口号。

90

addressMask

int32

[24-32]

-

addressMask,用户自定义时填写,范围24-32。

30

advanceSetEnable

boolean

  • true

  • false

-

高级设置开关。

true:开启,方向和匹配规则设置生效;

false:关闭。

false

direction

int32

[0-2]

-

方向,该字段可以设置为以下几种:

a) 0:双向

b) 1:外部访问内部

c) 2:内部访问外部

1

natRuleInfos

ARRAY_REFERENCE

0-100个列表项,详细请参见表7

规则信息。

-

support.huaweicloud.com/qiankuncmn-qiankuncs/toctopics/zh-cn_topic_0000001870588589.html