获取隧道列表

所需 OAuth scope：tunnel:read

分页获取当前用户的隧道列表。可通过 center=true 为每条记录附带节点所在地区的地图中心坐标 node_center。

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

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

错误响应：

code	msg
401	authorization header is missing
401	invalid token
403	OAuth2权限不足，需要以下权限之一: tunnel:read
500	获取隧道列表失败

Bearer Token

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "list": [
      {
        "id": 12,
        "name": "3f2a9c1e0b7d4e6fa1c2d3e4f5a6b7c8",
        "type": "tcp",
        "node_id": 1,
        "local_ip": "127.0.0.1",
        "local_port": 22,
        "remote_port": 20001,
        "custom_domain": "",
        "config": {
          "auto_tls": false
        },
        "bandwidth_limit": 10,
        "status": "inactive",
        "remark": "SSH",
        "node_name": "香港-01",
        "node_address": "hk1.example.com",
        "client_version": "0.69.2",
        "node_center": {
          "latitude": 22.3193,
          "longitude": 114.1694
        }
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 10,
    "total_page": 1
  }
}

🟠401错误 401

🟠403错误 403

🔴500错误 500

请求参数

请求示例代码

返回响应