跳转到主要内容
API Explorer|API Explorer
资源中心/网络服务/网络服务相关接口/端口转发相关接口
POSTPort Forwarding Operations起始版本 0.6同步需要认证

创建端口转发规则

创建端口转发规则

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • vipUuidString必填

      暂无描述。

    • vipPortStartInteger必填

      VIP的起始端口号

    • vipPortEndInteger

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

    • privatePortStartInteger

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

    • privatePortEndInteger

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

    • protocolTypeString必填

      网络流量协议类型

    • vmNicUuidString

      云主机网卡UUID

    • allowedCidrString

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

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • resourceUuidString

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

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryPortForwardingRuleInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • vipIpString必填

      VIP的IP地址

    • guestIpString必填

      虚拟机网卡的IP地址

    • vipUuidString必填

      暂无描述。

    • vipPortStartInteger必填

      VIP的起始端口号

    • vipPortEndInteger必填

      VIP的结束端口号

    • privatePortStartInteger必填

      客户IP的起始端口号

    • privatePortEndInteger必填

      客户IP的结束端口号

    • vmNicUuidString必填

      云主机网卡UUID

    • protocolTypeString必填

      网络流量的协议类型

    • stateString必填

      规则可用状态

    • allowedCidrString必填

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

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

POST/zstack/v1/port-forwarding

/zstack/v1/port-forwarding

操作 ID

CreatePortForwardingRule

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/port-forwarding' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"vipUuid":"<vipUuid>","vipPortStart":1,"vipPortEnd":1,"privatePortStart":1,"privatePortEnd":1,"protocolType":"<protocolType>","vmNicUuid":"<vmNicUuid>","allowedCidr":"<allowedCidr>","name":"<name>","description":"<description>","resourceUuid":"<resourceUuid>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "895a8ce93d274db78e2ef1462f8b8a29", "name": "TestAttachRule", "description": "test atatch rule", "vipIp": "192.168.0.187", "guestIp": "10.0.0.244", "vipUuid": "6151c96fd2ac4d6cbd8f8eedffc06de5", "vipPortStart": 33.0, "vipPortEnd": 33.0, "privatePortStart": 33.0, "privatePortEnd": 33.0, "vmNicUuid": "581ea3b08aef4096ac24e160f1ab0f8e", "protocolType": "TCP", "state": "Enabled", "allowedCidr": "0.0.0.0/0", "createDate": "Jun 7, 2017 9:20:10 PM", "lastOpDate": "Jun 7, 2017 9:20:10 PM" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史