StartTerminalSession
基于会话管理功能创建一个会话。您可以通过指定ECS实例ID与该实例建立一个WebSocket会话,通过接口返回的WebSocketUrl可以远程连接到ECS实例
服务地址:
华东1 金融云
输入参数
只看必填
RegionId实例所在地域ID
InstanceId实例ID列表
0指定的ECS实例ID
PortNumber指定ECS实例的端口号
CommandLine发起会话后
TargetServer指定通过实例访问VPC内目标服务地址
Username指定连接时的用户名称
ConnectionType远程连接实例所需WebSocket U...
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

当您通过代码定制化远程连接客户端时,可以调用该接口获取远程连接 ECS 实例的 WebSocketUrl。调用该接口时您需要注意:

  • 指定的 ECS 实例必须处于运行中(Running)状态。
  • 指定的 ECS 实例必须安装了云助手 Agent。您可以调用 DescribeCloudAssistantStatus 查询 ECS 实例是否已安装云助手 Agent,并可以查询云助手 Agent 的版本号。
    • 如果您的 ECS 实例没有安装云助手 Agent,请调用 InstallCloudAssistant 安装。
    • 云助手 Agent 的版本需要高于以下版本才支持会话管理功能。如果您需要升级云助手 Agent 版本,请参见升级或禁止升级云助手 Agent
      • Linux 操作系统:2.2.3.256
      • Windows 操作系统:2.1.3.256
  • 成功调用该接口后,WebSocketUrl 有效时长为 10 分钟。
  • 在会话建立后,3 分钟没有数据传输,云助手会关闭链接。
  • 同一地域下,已创建并可用的会话不能超过 1000 个,单台 ECS 实例处于连接状态的会话不能超过 20 个,单个会话连接的带宽限制为 200kb/s。
  • 端口转发功能,目前只支持 TCP 端口转发,不支持 UDP。
  • 若想永久关闭会话,并使 WebSocketUrl 失效,请调用 EndTerminalSession 接口。

请求参数

字段名称字段详情
RegionIdstring

实例所在地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
InstanceIdarray<string>

实例 ID 列表。

子级条数 <= 100
PortNumberinteger<int32>

指定 ECS 实例的端口号,用于数据转发。一旦设置该参数,云助手 Agent 的数据转发会传到指定的端口号,用于端口转发。例如,SSH 使用 22 端口。展开详情

示例值:22
CommandLinestring

发起会话后,指定执行的命令内容。长度不能超过 512 个字符。展开详情

示例值:ssh root@192.168.0.246
TargetServerstring

指定通过实例访问 VPC 内目标服务地址。展开详情

示例值:192.168.0.246
Usernamestring

指定连接时的用户名称。

示例值:testUser
ConnectionTypestring

远程连接实例所需 WebSocket URL 的网络类型。展开详情

示例值:Intranet

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:EB5173B0-8E80-564E-AAD1-3135412*****
SessionIdstring

会话 ID。

示例值:s-hz023od0x9****
SecurityTokenstring

附加在 WebSocket 的请求头部,用于系统校验本次请求。

示例值:d86c2df2-d19c-4bd8-b817-a19ef123****
WebSocketUrlstring

远程连接 ECS 实例的 WebSocket 会话对应的 URL。包含了会话 ID(SessionId)以及用于系统校验的SecurityToken

示例值:wss://cn-hangzhou.axt.aliyuncs.com/session?sessionId=s-hz023od0x9****&token=d86c2df2-d19c-4bd8-b817-a19ef123****
变更历史
暂无变更历史