FastOS
API
首页
教程
API
相关下载
社区
在线调试工具
接口规范
云主机服务
云虚拟主机
云数据库
企业邮局
相关代码
消息推送
其它服务
端口转发
# 接口目录 |接口名称|接口描述| | ------------ | ------------ | |[Portproxy.Add](#1、Portproxy.Add "Portproxy.Add")|添加转发规则| |[Portproxy.Edit](#2、Portproxy.Edit "Portproxy.Edit")|编辑转发规则| |[Portproxy.Delete](#3、Portproxy.Delete "Portproxy.Delete")|删除转发规则| # 1、Portproxy.Add ### 1.1 接口描述 添加端口转发规则 ### 1.2 接口参数 |参数名|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |RelayType|int|-|必填|转发类型,可选值:1表示ipv4到ipv4,2表示ipv4到ipv6,3表示ipv6到ipv4,4表示ipv6到ipv6| |OriginAddress|String|-|必填|源地址,根据不同的转发规则,设置不同的格式,如RelayType为1或2,那么格式需ipv4,3或4为ipv6。同时支持使用主机名作为IP地址使用,应注意FastOSAPI不验证该值格式是否正确,需调用者自行验证。| |OriginPort|int|-|必填|源端口,可选值1~65535,FastOSAPI不验证该端口是否已被占用| |TargetAddress|String|-|必填|目标地址,根据不同的转发规则,设置不同的格式,如RelayType为1或2,那么格式需ipv4,3或4为ipv6。同时支持使用主机名作为IP地址使用,应注意FastOSAPI不验证该值格式是否正确,需调用者自行验证。| |TargetPort|String|-|必填|目标端口,可选值1~65535| |Protocol|String|-|必填|转发协议,目前仅支持tcp| ### 1.3 接口示例 ` http://yourhost:2390/api/service/Portproxy.Add?_RPW_Sign=9E3BF12B5A069C543CAF27CCF184AEE2&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220825001208282&_RPW_IsAsyn=0&RelayType=1&OriginPort=88&OriginAddress=127.0.0.1&TargetPort=88&TargetAddress=10.0.0.2&Protocol=tcp ` ### 1.4 接口返回data说明 返回String类型,success ### 1.5 接口返回成功示例 ```json {"aqid":0,"state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":"success"} ``` # 2、Portproxy.Edit ### 2.1 接口描述 编辑端口转发规则 ### 2.2 接口参数 |参数名|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |OriginAddress|String|-|必填|源地址,根据不同的转发规则,设置不同的格式,如RelayType为1或2,那么格式需ipv4,3或4为ipv6。同时支持使用主机名作为IP地址使用,应注意FastOSAPI不验证该值格式是否正确,需调用者自行验证。| |OriginPort|int|-|必填|源端口,可选值1~65535,FastOSAPI不验证该端口是否已被占用| |Protocol|String|-|必填|转发协议,目前仅支持tcp| |TargetAddress|String|-|必填|目标地址,根据不同的转发规则,设置不同的格式,如RelayType为1或2,那么格式需ipv4,3或4为ipv6。同时支持使用主机名作为IP地址使用,应注意FastOSAPI不验证该值格式是否正确,需调用者自行验证。| |TargetPort|String|-|必填|目标端口,可选值1~65535| ### 2.3 接口示例 ` http://yourhost:2390/api/service/Portproxy.Edit?_RPW_Sign=9E3BF12B5A069C543CAF27CCF184AEE2&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220825001208282&_RPW_IsAsyn=0&OriginPort=88&OriginAddress=127.0.0.1&TargetPort=88&TargetAddress=10.0.0.2&Protocol=tcp ` ### 2.4 接口返回data说明 返回String类型,success ### 2.5 接口返回成功示例 ```json {"aqid":0,"state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":1} ``` # 3、Portproxy.Delete ### 3.1 接口描述 删除端口转发规则 ### 3.2 接口参数 |参数名|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |OriginAddress|String|-|必填|源地址,根据不同的转发规则,设置不同的格式,如RelayType为1或2,那么格式需ipv4,3或4为ipv6。同时支持使用主机名作为IP地址使用,应注意FastOSAPI不验证该值格式是否正确,需调用者自行验证。| |OriginPort|int|-|必填|源端口,可选值1~65535,FastOSAPI不验证该端口是否已被占用| |Protocol|String|-|必填|转发协议,目前仅支持tcp| ### 3.3 接口示例 ` http://yourhost:2390/api/service/Portproxy.Delete?_RPW_Sign=9E3BF12B5A069C543CAF27CCF184AEE2&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220825001208282&_RPW_IsAsyn=0&OriginPort=88&OriginAddress=127.0.0.1&Protocol=tcp ` ### 3.4 接口返回成功示例 ```json {"aqid":0,"state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":1} ```