You need to enable JavaScript to run this app.
文档中心
云手机

云手机

复制全文
下载 pdf
ADB 管理
获取 ADB Tunnel 连接信息 GetEdgeTunnelConnectionInfo
复制全文
下载 pdf
获取 ADB Tunnel 连接信息 GetEdgeTunnelConnectionInfo
获取客户端连接远程边缘实例所需的信息,包括用于建立安全转发通道的 Tunnel(即客户端与远程实例之间建立的一条安全传输通道)URL,以及启动转发服务所需的参数。客户端建立通道后,可通过该通道转发 ADB 二进制协议数据,从而访问远程实例。 ​
注意​
当前不支持通过 SSH 直接登录实例,SSH 仅作为通道承载层使用,支持转发 ADB 数据,用于承载 ADB 连接。​
请求说明​
  • 请求方式:POST​
  • 请求地址:https://open.volcengineapi.com?Action=GetEdgeTunnelConnectionInfo&Version=2025-05-01​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见 公共参数。​
Query​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
GetEdgeTunnelConnectionInfo​
接口名称。当前 API 的名称为 GetEdgeTunnelConnectionInfo。​
Version​
String​
是​
2025-05-01​
接口版本。当前 API 的版本为 2025-05-01。​
​
Body​
​
参数​
类型​
是否必选​
示例值​
描述​
ProductId​
String​
是​
1749281594201***​
业务 ID,管理云手机资源、开展云手机业务的标识。您可以登录 云手机控制台,在已创建的业务卡片中获取。​
PodId​
String​
是​
7295222843434***​
用于指定需要获取边缘 Tunnel 连接信息的目标实例 ID。您可以通过 ListPod 接口获取。​
TunnelType​
String​
否​
adb​
指定需要获取的 Tunnel 连接类型,当前暂仅支持 adb(默认值),即获取 ADB 类型的 Tunnel 连接,用于远程连接和调试云手机实例。​
TTL​
Integer​
否​
3600​
Tunnel 连接信息的有效时长,单位为秒,默认值为 3600(即 1 小时),最大值为 86400(即 24 小时)。​
注意​
TTL 控制连接信息/签名 URL 的有效期;建议按实际使用时长设置,不要长期暴露或保存返回的 TunnelURL。​
Timeout​
Integer​
否​
10​
Tunnel 连接的请求超时时间,单位为秒,未指定时使用系统默认配置。​
​
返回参数​
下表仅列出本接口特有的返回参数。更多信息请参见 返回结构。​
​
参数​
类型​
示例值​
描述​
ConnectionInfo​
-​
边缘 Tunnel 连接的详细信息。​
​
EdgeTunnelConnectionInfo​
​
参数​
类型​
示例值​
描述​
Note​
String​
# ADB Over SSH Tunnel 使用示例\n\n## 建立 SSH Tunnel 连接 (over WebSocket)\n\n~~~bash\nssh \\\n -o \"ProxyCommand=ws-tunnel --url 'wss://tjtj-ctcucm*****​
边缘 Tunnel 连接的使用说明。​
SSHHost​
String​
test-pod.prod-a​
SSH 连接的主机地址,用于建立边缘 Tunnel 的 SSH 连接。​
SSHUser​
String​
adb​
建立边缘 Tunnel 的 SSH 连接时使用的用户名。​
ExpiresAt​
Long​
1707278000​
连接信息的过期时间,采用 Unix 秒级时间戳表示。​
TunnelURL​
String​
wss://...​
用于建立边缘 Tunnel 连接的 WebSocket 安全协议 URL,通过该地址可以与云手机实例建立隧道连接(如 ADB 或 SSH 隧道)。​
TargetHost​
String​
test-pod.prod-a​
边缘 Tunnel 连接的目标主机地址。​
TargetPort​
String​
5555​
边缘 Tunnel 连接的目标端口,用于指定建立隧道时要连接的端口。​
TunnelType​
String​
adb​
Tunnel 连接类型,当前暂仅支持 adb,即获取 ADB 类型的 Tunnel 连接,用于远程连接和调试云手机实例。​
ConnectionId​
String​
sid-xxxxxx​
边缘 Tunnel 连接信息 ID。​
HostKeyAlias​
String​
ssh-gw.domain...​
SSH 连接时使用的主机密钥别名,用于标识对应的主机密钥,避免每次连接时重复验证主机密钥,简化连接流程并提升安全性。​
​
请求示例​
​
POST https://open.volcengineapi.com?Action=GetEdgeTunnelConnectionInfo&Version=2025-05-01​
{​
"ProductId": "1749281594201***",​
"PodId": "7295222843434***",​
"TunnelType": "adb",​
"TTL": 3600,​
"Timeout": 10​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"Action": "GetEdgeTunnelConnectionInfo",​
"Region": "cn-north-1",​
"Service": "ACEP",​
"Version": "2025-05-01",​
"RequestId": "20230604110420****100232280022D31"​
},​
"Result": {​
"ConnectionInfo": {​
"Note": "# ADB Over SSH Tunnel 使用示例\n\n## 建立 SSH Tunnel 连接(over WebSocket)\n\n~~~bash\nssh \\\n -o \"ProxyCommand=ws-tunnel --url 'wss://tjtj-ctcucm*****",​
"SSHHost": "test-pod.prod-a",​
"SSHUser": "adb",​
"ExpiresAt": 1707278000,​
"TunnelURL": "wss://...",​
"TargetHost": "test-pod.prod-a",​
"TargetPort": "5555",​
"TunnelType": "adb",​
"ConnectionId": "sid-xxxxxx",​
"HostKeyAlias": "ssh-gw.domain..."​
}​
}​
}​
​
错误码​
您可访问 公共错误码,获取更多错误码信息。​
最近更新时间:2026.08.05 20:37:01
这个页面对您有帮助吗?
有用
有用
无用
无用