CreateSession - 创建会话

创建Web Terminal会话。

接口说明

创建会话的接口,返回前端 EndPoint,并且起一个周期任务跟踪会话状态

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eflo:CreateSessioncreate
*Cluster
acs:eflo:{#regionId}:{#accountId}:cluster/{#ClusterId}

请求参数

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

实例 ID。

e01-cn-kvw44e6****
StartTimestring

发起时间,13 位时间戳。

1669340937156
SessionTypestring

会话包对应的会话类型。

N 两种: Sol:基于串口[默认] Assistant:基于云助手

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

887FA855-89F4-5DB3-B305-C5879EC480E6
WssEndpointstring

WebSocket 地址。

ws://x.x.x.x:xx/calypso_web_console
SessionIdstring

会话 ID。

i20702387166936479****
SessionTokenstring

会话凭证。

03f53c719015a9ad4f4f55d66cac2dac161b18e8065ca75a3220b89de389****
ServerSnstring

节点 ID。

2A591****

示例

正常返回示例

JSON格式

{
  "RequestId": "887FA855-89F4-5DB3-B305-C5879EC480E6",
  "WssEndpoint": "ws://x.x.x.x:xx/calypso_web_console",
  "SessionId": "i20702387166936479****",
  "SessionToken": "03f53c719015a9ad4f4f55d66cac2dac161b18e8065ca75a3220b89de389****",
  "ServerSn": "2A591****"
}

错误码

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