调用StartTerminalSession基于会话管理功能创建一个会话。您可以通过指定ECS实例ID与该实例建立一个WebSocket会话，通过接口返回的WebSocketUrl可以远程连接到ECS实例。
接口说明
当您通过代码定制化远程连接客户端时，可以调用该接口获取远程连接 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 接口。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:StartTerminalSession | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 实例所在地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| InstanceId | array | 是 | 实例 ID 列表。 | |
| string | 是 | 指定的 ECS 实例 ID。N 表示可以同时指定多台 ECS 实例，最多可指定 10 台 ECS 实例。N 的取值范围：1~10。 | i-bp1eifrtpxa9tb**** | |
| PortNumber | integer | 否 | 指定 ECS 实例的端口号，用于数据转发。一旦设置该参数，云助手 Agent 的数据转发会传到指定的端口号，用于端口转发。例如，SSH 使用 22 端口。 默认值为空，表示不设置数据转发的端口号。 | 22 |
| CommandLine | string | 否 | 发起会话后，指定执行的命令内容。长度不能超过 512 个字符。 说明
指定了 CommandLine后，不能再指定PortNumber和TargetServer。
| ssh root@192.168.0.246 |
| TargetServer | string | 否 | 指定通过实例访问 VPC 内目标服务地址。 说明
当该参数不为空时， PortNumber表示通过托管实例访问 VPC 内目标服务的端口号。
| 192.168.0.246 |
| Username | string | 否 | 指定连接时的用户名称。 | testUser |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "EB5173B0-8E80-564E-AAD1-3135412*****",
"SessionId": "s-hz023od0x9****",
"SecurityToken": "d86c2df2-d19c-4bd8-b817-a19ef123****",
"WebSocketUrl": "wss://cn-hangzhou.axt.aliyuncs.com/session?sessionId=s-hz023od0x9****&token=d86c2df2-d19c-4bd8-b817-a19ef123****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | RegionId.ApiNotSupported | The api is not supported in this region. | 指定地域下不支持调用 API。请检查 RegionId 参数取值是否正确。 |
| 400 | PortNumber.Invalid | The port number is invalid. | 端口号非法。 |
| 403 | InstanceIds.ExceedLimit | The number of instance IDs exceeds the upper limit. | 目标实例数量超过上限。 |
| 403 | SessionCount.ExceedLimit | The number of sessions exceeds the upper limit. | 处于连接状态的会话数量超过上限。 |
| 403 | Operation.Forbidden | The operation is not permitted. | 该操作是不被允许的。 |
| 403 | PortForwarding.NotSupported | Port forwarding is not supported currently. | 端口转发功能暂未支持。 |
| 403 | UserBehavior.SessionManagerDisabled | The api is disabled by user behavior. | 用户通过会话管理远程连接功能已关闭。建议确保会话管理已开启（全地域）来进行远程管理。 |
| 403 | InvalidCommandLine.Conflict | The parameter PortNumber or TargetServer cannot be specified with parameter CommandLine. | 参数CommandLine不能与参数PortNumber或TargetServer一起指定。 |
| 403 | InvalidTargetServer.MissingPortNumber | The parameter PortNumber must be specified with parameter TargetServer. | 使用参数TargetServer时必须同时指定参数PortNumber。 |
| 403 | InvalidCommandLine.LengthLimitExceeded | The length of the parameter CommandLine exceeded the limit of 512 characters. | 参数CommandLine的内容长度超过了512个字符的限制。 |
| 403 | InvalidInstanceIds.CountLimitExceeded | The count of Instances exceeded the maximum limit of 1 when TargetServer or CommandLine parameter was specified. | 使用了TargetServer或CommandLine参数时，Instances的数量超过了最大限制，限制Instances数量仅为1。 |
| 403 | Username.ExceedLimit | The length of the username exceeds the upper limit. | 用户名长度超过上限。 |
| 403 | InvalidOperation.SecurityGroupRuleDenied | The operation is not allowed by the security group inbound rules of the specified instance. | 指定的实例的安全组入方向规则不允许该操作。 |
| 403 | InvalidTargetServer.LengthLimitExceeded | The length of the parameter TargetServer exceeded the limit of 128 characters. | 参数TargetServer的长度超过了128个字符的限制。 |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 指定的地域RegionId不存在. |
| 404 | InvalidInstance.NotFound | The specified instances not found. | 指定的实例ID不存在。 |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | 发送请求时发生错误，请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-05 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-07-18 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-04-28 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-03-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-08-16 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-05-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-03-15 | OpenAPI 错误码发生变更 | 查看变更详情 |