续断隧道管理API

续断API文档

如何在智能设备中预装续断客户端
如何在软件中捆绑安装续断客户端
查看示例代码


公共参数

apikey: 【请登录续断控制台,到“用户信息”页生成】

隧道

隧道模板购买/升级/续期

Method: GET

URL: /api/v2/order/tunnel+公共参数

请求参数(Query)
名称 类型 是否必须 描述
id String 升级时指定模板id
amount Number 购买隧道模板数量(1 ~ 255),升级/续期时不能带此参数
bandwidth Number 模板默认带宽(单位:Mbps),可选
1、2、4、6、8、12、16、20、24
expiresIn Number 购买时长(单位:月),可选
1、6、12、24、36、60
响应参数
名称 类型 描述
error Number 错误码
0:成功
2:参数无效
3:余额不足
4:模板数量到达上限
5:模板已过期
info String 具体错误信息
data String 操作成功时返回,包含模板id和本次消费金额(单位:分)


新建隧道

Method:POST

URL:/api/v2/mapping/tunnel+公共参数

请求参数(Body)

格式可以为 application/json 或 application/x-www-form-urlencoded

可选参数不提交则使用默认值**

名称 类型 是否必须 描述
name String 隧道名称
machineID String 客户端ID(可从我的客户端列表API获取)
type String 映射类型
0:TCP
1:HTTP
2:HTTPS
5:UDP
templet String 我的隧道ID(可从我的可用模板列表API获取)
ip String 内网主机IP
port String 内网端口
customDomain String 自有域名
provider String 域名备案服务商
0:不使用
1:使用腾讯云备案
2:其他或未备案
bandwidth String 高速流量带宽单位Mbps
wol String 远程唤醒
0:不启用
1:启用
响应参数
名称 类型 描述
error Number 错误码
0:成功
1:失败(暂定)
id String 新建隧道ID
domain String 系统分配的域名
port Number 系统分配的端口,HTTP/HTTPS隧道默认80/443


修改隧道

Method:PUT

URL:/api/v2/mapping/tunnel+公共参数

请求参数(Body)

格式可以为 application/json 或 application/x-www-form-urlencoded

可选参数不提交则使用默认值

名称 类型 是否必须 描述
id String 隧道ID,修改时必须提交
name String 隧道名称
machineID String 客户端ID(可从我的客户端列表API获取)
templet String 我的隧道ID(可从我的可用模板列表API获取)
ip String 内网主机IP(127.0.0.1)
port String 是* 内网端口,*同端口隧道不允许修改
customDomain String 自有域名
provider String 域名备案服务商
0:不使用(默认)
1:使用腾讯云备案
2:其他或未备案
ipWhite String 允许访问源IP(半角逗号分隔)
accessMode String 访问控制
0:允许所有(默认)
1:指定源IP
bandwidth String 高速流量带宽单位Mbps
wol String 远程唤醒
0:不启用(默认)
1:启用
响应参数
名称 类型 描述
error Number 错误码
0:成功
1:失败(暂定)
id String 修改隧道ID


获取隧道列表

Method:GET

URL:/api/v2/mapping/tunnel+公共参数

请求参数(Query)
名称 类型 是否必须 描述
id String 隧道ID
machineID String 客户端ID
type String 隧道类型
from Number 当前页数,默认0
每页条目数同size
size Number 返回条目数,默认1,最大10
响应参数
名称 类型 描述
error Number 错误
0:成功
1:失败
data Tunnel* 隧道列表
current Number 当前返回的列表数量
total Number 本次查询列表的总数量

Tunnel*

名称 类型 描述
id String 隧道id
name String 隧道名称
type String 隧道类型
0:TCP
1:HTTP
2:HTTPS
5:UDP
ip String 内网主机地址
port String 内网主机端口
tunnelport Number 外网端口
sysDomain String 隧道默认域名
customDomain String 自有域名
state Number 隧道状态
0:停止
1:运行中
2:正在初始化
stateInfo String 隧道详细状态(本地化)
expiredAt String 服务截至时间
connectivity Number 隧道连通性
0:失败
1:正常
wol String 启用远程唤醒
0:不启用
1:启用
enabled Number 隧道状态
0:禁用
1:启用
bandwidth String 高速流量指定带宽,0 - 16Mbps,
非零表示使用高速流量
usedflow Number 已使用免费流量(单位:MB)
usedPayFlow Number 已使用付费流量(单位:MB)
accessMode String 访问控制
0:允许所有
1:指定源IP
ipWhite String 允许访问源IP,多个用半角逗号分隔
updatetime String 隧道修改时间
provider String 域名备案服务商
0:不使用
1:使用腾讯云备案
2:其他或未备案
willBeExpired Boolean 7天内即将过期
expired Boolean 已过期
recovered Boolean 已过期,域名端口资源已回收
outdated Boolean 客户端版本低
machine 客户端信息,具体如下:
id String 客户端ID
name String 客户端主机名
remark String 客户端备注名
version String 客户端版本
online Number 客户端是否在线
templet 隧道模板信息,具体如下:
id String 隧道模板ID
type Number 模板类型:
0:端口随机(自定义)隧道
3:同端口(自定义)隧道
254:5元永久免费隧道
255:免费隧道
concurrency Number 并发数


删除隧道

Method:DELETE

URL:/api/v2/mapping/tunnel+ 公共参数

请求参数

Query:

名称 类型 是否必须 描述
id String 删除隧道ID

Body:

格式可以为 application/json 或 application/x-www-form-urlencoded

名称 类型 是否必须 描述
ids Array 批量删除隧道ID
响应参数
名称 类型 描述
error Number 错误码
0:成功
1:失败
data Number 删除成功的条目数


启用/停用隧道

Method:PUT

URL:/api/v2/mapping/enable+公共参数

请求参数(Query)
名称 类型 是否必须 描述
id String 隧道ID
enable Number 隧道状态:
0:禁用
1:启用
不带本参数默认切换当前状态
相应参数
名称 类型 描述
error Number 错误码
0:成功
1:失败


 

获取我的可用模板列表

Method:GET

URL:/api/v2/mapping/valid+公共参数

请求参数(Query)
名称 类型 是否必须 描述
tunnelType Number 隧道类型:
0:TCP
1:HTTP
2:HTTPS
5:UDP
type Number 模板类型:
0:端口随机(自定义)隧道
3:同端口(自定义)隧道
254:5元永久免费隧道
255:免费隧道
bandwidth Number 模板带宽:
可选1、2、4、8、12、16、20、24
size Number 返回条目数,默认1,最大10
响应参数
名称 类型 描述
error Number 错误码
0:成功
1:失败
data Templet* 模板明细
current Number 当前返回的可用模板
total Number 本次查询列表的总数量

Templet*

名称 类型 描述
id String 隧道ID
type Number 模板类型:
0:端口随机(自定义)隧道
3:同端口(自定义)隧道
254:5元永久免费隧道
255:免费隧道
bandwidth Number 模板带宽:
可选1、2、4、8、12、16、20、24
concurrency Number 并发数
domain Number 是否支持自有域名
0:否
1:是
expiredAt String 服务截至时间
expiresIn Number 有效期剩余(单位:天)


 

获取我的客户端列表

Method:GET

URL:/api/v2/machine/list+公共参数

请求参数(Query)
名称 类型 是否必须 描述
IP String 客户端内网IP
publicIP String 客户端公网IP
MAC String MAC地址
name String 主机名
remark String 备注名
online String 是否在线
0:离线
1:在线
from String 当前页数,默认0
每页条目数同size
size String 返回条目数,默认1,最大10
idle String 是否未绑定隧道
1:是
0:否
响应参数
名称 类型 描述
error Number 错误码
0:成功
1:失败
data Machine* 客户端明细
current Number 当前返回的可用模板
total Number 本次查询列表的总数量

Machine*

名称 类型 描述
id String 客户端ID
name String 主机名
remark String 备注名
os String 操作系统类型
ip String 内网IP
publicIP String 公网IP
mac String MAC地址
version String 客户端版本
activetime String 最后在线时间
isActive Number 是否在线


客户端升级

Method:PUT

URL:/api/v2/machine/upgrade+ 公共参数

请求参数

Query:

名称 类型 是否必须 描述
id String 需要升级的客户端ID

Body:

格式可以为 application/json 或 application/x-www-form-urlencoded

名称 类型 是否必须 描述
ids Array 需要升级的客户端ID
响应参数
名称 类型 描述
error Number 错误码
0:成功,其他参考info
info String 错误信息


示例

新建HTTP隧道
1.获取客户端ID
curl -X GET 'https://xd.zhexi.tech/api/v2/machine/list?apikey=XXX'

Response:

{                                                  
  "error": 0,                                      
  "data": [                                        
    {                                              
      "id": "machine-id",
      "name": "sample-windows",                     
      "remark": "",                                
      "os": "Windows 10 Pro",                      
      [...]                               
    }                                              
  ],                                               
  "total": 1,                                     
  "current": 1                                     
}
2.获取可用隧道模板
curl -X GET 'https://xd.zhexi.tech/api/v2/mapping/valid?apikey=XXX&tunnelType=1'

Response:

{
  "error": 0,
  "data": [
    {
      "id": "tunnel-templet-id",
      "type": 0,                                   
      "bandwidth": 16,                             
      "concurrency": 250,                          
      [...]
    }
  ],
  "current": 1,
  "total": 1
}
3.新建隧道

machine-id 由步骤1获得
tunnel-templet-id 由步骤2获得

curl -X POST 'https://xd.zhexi.tech/api/v2/mapping/tunnel?apikey=XXX' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "API新建隧道",
    "machineID": "machine-id",
    "templet": "tunnel-templet-id",
    "type": "1",
    "ip": "127.0.0.1",
    "port": "80"
}'

Response:

{
  "error": 0,
  "data": {
    "id": "XXX",
    "domain": "XXX.51http.tech",
  }
}

篇文档关于 ""

    未找到任何关于 "" 的文档