All Products
Search
Document Center

Simple Application Server:StartTerminalSession

Last Updated:Apr 17, 2024

Creates a session for a simple application server.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the simple application server. You can call the ListRegions operation to query the most recent region list.

cn-hangzhou
InstanceIdstringYes

The ID of the simple application server.

ace0706b2ac4454d984295a94213****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

Id of the request

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

The session ID.

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

The security token included in the WebSocket request header. The system uses this token to authenticate the request.

token-xxxaaz
WebSocketUrlstring

The URL of the WebSocket session that is used to connect to the server. The URL contains the session ID (SessionId) and the authentication token (SecurityToken).

wss://xxxx

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history