跳转到主要内容
ZStack
资源中心/网络服务/网络服务相关接口/端口转发相关接口

创建端口转发规则

创建端口转发规则

POST/zstack/v1/port-forwarding

操作 ID

CreatePortForwardingRule

起始版本

0.6

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • params
    Object必填

    请求体参数结构

    • vipUuid
      String必填

      暂无描述。

    • vipPortStart
      Integer必填

      VIP的起始端口号

    • vipPortEnd
      Integer

      VIP的结束端口号; 如果忽略不设置, 会默认设置为vipPortStart

    • privatePortStart
      Integer

      客户IP（虚拟机网卡的IP地址）的起始端口号; 如果忽略不设置, 会默认设置为vipPortStart

    • privatePortEnd
      Integer

      客户IP（虚拟机网卡的IP地址）的结束端口号; 如果忽略不设置, 会默认设置为vipPortEnd

    • protocolType
      String必填

      网络流量协议类型

    • vmNicUuid
      String

      云主机网卡UUID

    • allowedCidr
      String

      源CIDR; 端口转发规则只作用于源CIDR的流量; 如果忽略不设置, 会默认设置为to 0.0.0.0/0

    • name
      String必填

      资源名称

    • description
      String

      资源的详细描述

    • resourceUuid
      String

      用户指定的资源UUID，若指定，系统不会为该资源随机分配UUID

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventory
    PortForwardingRuleInventory必填

    详情参考inventory

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • vipIp
      String必填

      VIP的IP地址

    • guestIp
      String必填

      虚拟机网卡的IP地址

    • vipUuid
      String必填

      暂无描述。

    • vipPortStart
      Integer必填

      VIP的起始端口号

    • vipPortEnd
      Integer必填

      VIP的结束端口号

    • privatePortStart
      Integer必填

      客户IP的起始端口号

    • privatePortEnd
      Integer必填

      客户IP的结束端口号

    • vmNicUuid
      String必填

      云主机网卡UUID

    • protocolType
      String必填

      网络流量的协议类型

    • state
      String必填

      规则可用状态

    • allowedCidr
      String必填

      源CIDR; 端口转发规则只作用于源CIDR的流量

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间