StartTerminalSession - 开启免密登录会话

为轻量应用服务器提供会话登录能力。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
swas-open:StartTerminalSession
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

指定的轻量应用服务器实例所属的地域 ID。 您可以调用 ListRegions 查看支持的阿里云地域列表。

cn-hangzhou
InstanceIdstring

轻量应用服务器的实例 ID。

ace0706b2ac4454d984295a94213****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

20758A-585D-4A41-A9B2-28DA8F4F****
SessionIdstring

会话 ID。

ffb90b6e-b18a-4a33-88cf-86fb88****
SecurityTokenstring

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

token-xxxaaz
WebSocketUrlstring

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

wss://xxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "SessionId": "ffb90b6e-b18a-4a33-88cf-86fb88****",
  "SecurityToken": "token-xxxaaz",
  "WebSocketUrl": "wss://xxxx"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史