编辑隧道 - Lollia-Center

所需 OAuth scope：tunnel:write

编辑隧道。所有字段可选但至少提供一个（字段为 null/不传表示不修改）。规则：custom_domain 仅 HTTP/HTTPS 隧道可设置且不能为空，变更时需通过白名单验证（节点要求备案时需有 ICP 备案）；config.auto_tls 仅 HTTPS 隧道可开启且需已配置自定义域名；config.http_redirect 仅 HTTPS 隧道可开启；config.proxy_protocol_version 仅支持 v1/v2，config.protocol 仅支持 tcp/kcp，传空字符串表示清除。若修改了 local_ip/local_port/custom_domain/config 且隧道在线，会下发下线指令并置为 inactive，需重连客户端；msg 会随之变化（如 "更新成功，隧道已下线，请重新连接客户端使配置生效"）。无实际变更时返回 200，msg 为 "没有字段变更"。

鉴权：OAuth2 Access Token，Authorization: Bearer {{oauthAccessToken}}

OAuth2：支持 OAuth2 Access Token，需要 scope tunnel:write

错误响应：

code	msg
401	authorization header is missing
401	invalid token
403	OAuth2权限不足，需要以下权限之一: tunnel:write
400	请求参数错误: <校验错误>
400	至少需要提供一个可更新字段
400	仅 HTTP/HTTPS 类型隧道支持自定义域名
400	HTTP/HTTPS 类型隧道必须配置自定义域名
400	仅 HTTPS 类型隧道支持 Auto TLS
400	开启 Auto TLS 前必须配置自定义域名
400	仅 HTTPS 类型隧道支持 HTTP 自动跳转
400	配置无效: proxy_protocol_version 仅支持 v1/v2
400	域名验证失败: 域名未添加到白名单
403	无权操作该隧道
403	该域名未通过验证或不可用，请先添加并验证域名
403	该节点需要域名备案，请先完成ICP备案
404	隧道不存在
500	更新隧道失败

请求参数

Authorization

Bearer Token

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

Body 参数application/json必填

示例

{
  "local_port": 8080,
  "custom_domain": "www.example.com",
  "config": {
    "auto_tls": true,
    "http_redirect": true
  },
  "remark": "我的网站"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "id": 12,
    "name": "3f2a9c1e0b7d4e6fa1c2d3e4f5a6b7c8",
    "type": "https",
    "node_id": 1,
    "local_ip": "127.0.0.1",
    "local_port": 8080,
    "remote_port": 80,
    "custom_domain": "www.example.com",
    "config": {
      "auto_tls": true,
      "http_redirect": true
    },
    "bandwidth_limit": 10,
    "status": "inactive",
    "remark": "SSH",
    "client_version": "0.69.2"
  }
}

🟠401错误 401

🟠403错误 403

🟠400错误 400

🟠404错误 404

🔴500错误 500