All Products
Search
Document Center

Platform For AI:CreateSession

Last Updated:Jul 25, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Creates a Web Terminal session.

Operation description

The API creates a session, returns the frontend endpoint, and starts a periodic task to track the session status.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
eflo:CreateSessioncreate
*Cluster
acs:eflo:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NodeIdstringNo

The instance ID.

e01-cn-kvw44e6dn04
StartTimestringNo

The start time. The value is a 13-digit timestamp.

1669340937156
SessionTypestringNo

The type of the session corresponding to the session package.

Valid values: Sol (default): based on serial port Assistant: based on cloud assistant

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

The WebSocket address.

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

The session ID.

i207023871669364793713
SessionTokenstring

The session credential.

03f53c719015a9ad4f4f55d66cac2dac161b18e8065ca75a3220b89de389c980
ServerSnstring

The node ID.

2A59143F1

Examples

Sample success responses

JSONformat

{
  "RequestId": "887FA855-89F4-5DB3-B305-C5879EC480E6",
  "WssEndpoint": "ws://x.x.x.x:xx/calypso_web_console",
  "SessionId": "i207023871669364793713",
  "SessionToken": "03f53c719015a9ad4f4f55d66cac2dac161b18e8065ca75a3220b89de389c980",
  "ServerSn": "2A59143F1"
}

Error codes

For a list of error codes, visit the Service error codes.