文档目录

端口转发

创建端口转发规则(CreatePortForwardingRule)

管理员可以使用CreatePortForwardingRule创建端口转发规则。例如:

CreatePortForwardingRule name=pf1 protocolType=TCP vipUuid=818351340f534190b37dfead4d17341c \
vipPortStart=22 privatePortStart=23 privatePortEnd=23

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
vipUuid VIP的uuid 0.6
vipPortStart VIP的起始端口号 0.6
vipPortEnd VIP的结束端口号;如果忽略不设置,会默认设置为vipPortStart 是 0.6
privatePortStart 客户IP(虚拟机网卡的IP地址)的起始端口号;如果忽略不设置,会默认设置为vipPortStart 是 0.6
privatePortEnd 客户IP(虚拟机网卡的IP地址)的结束端口号;如果忽略不设置,会默认设置为vipPortEnd 是 0.6
protocolType 网络流量协议类型
  • TCP
  • UDP
0.6
vmNicUuid 云主机网卡uuid 是 0.6
allowedCidr 源CIDR;端口转发规则只作用于源CIDR的流量;如果忽略不设置,会默认设置为to 0.0.0.0/0 是 0.6
name 端口转发规则名称 0.6
description 端口转发规则的详细描述 是 0.6
resourceUuid 资源uuid 是 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 PortForwardingRuleVO 是 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 PortForwardingRuleVO 是 0.6
timeout 是

删除端口转发规则(DeletePortForwardingRule)

管理员可以使用DeletePortForwardingRule删除端口转发规则。例如:

DeletePortForwardingRule uuid=1855707e0a4f4894bcdfaa455d213ecb

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 端口转发规则的uuid 0.6
deleteMode 请参见 删除资源(Delete Resources) 是
  • Permissive
  • Enforcing
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 PortForwardingRuleVO 是 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 PortForwardingRuleVO 是 0.6
timeout 是

查询端口转发规则(QueryPortForwardingRule)

管理员可以使用QueryPortForwardingRule查询端口转发规则。例如:

QueryPortForwardingRule uuid=8c3c4c7864c54010a09dbd77e2bfeedd
QueryPortForwardingRule vip.name=vip-for-pf1

原生域查询(Primitive Fields of Query)

请参见port forwarding rule inventory

嵌套和扩展域查询(Nested and Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
vmNic vm nic inventory 0.6
vip vip inventory 0.6

更新端口转发规则(UpdatePortForwardingRule)

管理员可以使用UpdatePortForwardingRule更新端口转发规则。例如:

UpdatePortForwardingRule uuid=8c3c4c7864c54010a09dbd77e2bfeed

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 端口转发规则的uuid 0.6
name 端口转发规则的名称 是 0.6
description 端口转发规则的详细描述 是 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 PortForwardingRuleVO 是 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 PortForwardingRuleVO 是 0.6
timeout 是

改变端口转发规则的状态(ChangePortForwardingRuleState)

管理员可以使用ChangePortForwardingRuleState改变端口转发规则的状态。例如:

ChangePortForwardingRuleState uuid=8c3c4c7864c54010a09dbd77e2bfeedd stateEvent=disable

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 端口转发规则的uuid 0.6
stateEvent 端口转发规则的状态
  • enable
  • disable
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 PortForwardingRuleVO 是 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 PortForwardingRuleVO 是 0.6
timeout 是

获取云主机网卡列表(GetPortForwardingAttachableVmNics)

管理员可以使用GetPortForwardingAttachableVmNics获取云主机网卡列表。例如:

GetPortForwardingAttachableVmNics ruleUuid=8c3c4c7864c54010a09dbd77e2bfeedd

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
ruleUuid 规则的uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 PortForwardingRuleVO 是 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 PortForwardingRuleVO 是 0.6
timeout 是

挂载规则到虚拟机网卡上(AttachPortForwardingRule)

管理员可以使用AttachPortForwardingRule挂载规则到虚拟机网卡上。例如:

AttachPortForwardingRule ruleUuid=8c3c4c7864c54010a09dbd77e2bfeedd \
vmNicUuid=3e6a4cc2eb0941edbac7af24e2ff932f

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
ruleUuid 规则的uuid 0.6
vmNicUuid 云主机网卡uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 PortForwardingRuleVO 是 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 PortForwardingRuleVO 是 0.6
timeout 是

从虚拟机网卡卸载规则(DetachPortForwardingRule)

管理员可以使用DetachPortForwardingRule从虚拟机网卡卸载规则。例如:

DetachPortForwardingRule uuid=8c3c4c7864c54010a09dbd77e2bfeedd

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 规则的uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 PortForwardingRuleVO 是 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 PortForwardingRuleVO 是 0.6
timeout 是