透過 StartTerminalSession API 登入執行個體 - 輕量應用伺服器 - 阿里雲 - Simple Application Server

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

swas-open:StartTerminalSession

none

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	指定的Simple Application Server執行個體所屬的地區 ID。您可以調用 ListRegions 查看支援的阿里雲地區列表。	cn-hangzhou
InstanceId	string	是	Simple Application Server的執行個體 ID。	ace0706b2ac4454d984295a94213****
CommandLine	string	否	發起會話後，指定執行的命令內容。長度不能超過 512 個字元。	ssh root@192.168.0.***

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request	20758A-585D-4A41-A9B2-28DA8F4F****
SessionId	string	會話 ID。	ffb90b6e-b18a-4a33-88cf-86fb88****
SecurityToken	string	附加在 WebSocket 的要求標頭部，用於系統校正本次請求。	token-xxxaaz
WebSocketUrl	string	遠端連線Simple Application Server執行個體的 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"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	UserBehaviour.SessionManagerDisabled	The API is disabled by user behaviour.	使用者通過會話管理遠端連線功能已關閉。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。