DescribeTerminalSessions - Elastic Compute Service

檢視Session Manager工作階段歷史記錄。

介面說明

您可以查詢最近 30 天內建立的 Session Manager 工作階段記錄，工作階段記錄的保留上限為 1000 條成功的記錄。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeTerminalSessions

list

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地域 ID。	cn-hangzhou
InstanceId	string	否	執行個體 ID。	i-bp1i7gg30r52z2em****
SessionId	string	否	工作階段 ID。	s-hz023od0x9****
MaxResults	integer	否	分頁查詢時每頁的最大條目數。最大值為 100。預設值為 10。	10
NextToken	string	否	查詢憑證（Token），取值為上一次 API 呼叫傳回的 NextToken 參數值。	AAAAAdDWBF2****

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
NextToken	string	本次呼叫傳回的查詢憑證值。	AAAAAdDWBF2****
Sessions	object
Session	array<object>	工作階段列表。
	array<object>	工作階段資訊。
CreationTime	string	會話的建立時間。	2024-01-19T09:15:46Z
TargetServer	string	通過執行個體訪問 VPC 內的目標服務地址。	192.168.0.246
PortNumber	integer	ECS 執行個體的連接埠號碼，用於資料轉寄。若未設定資料轉寄的連接埠號碼，則該值為空白。	22
PrincipalId	string	身份標識。按照身份類型`IdentityType`，取值如下：當前調用者是阿里雲帳號：返回阿里雲帳號 ID。當前調用者是 RAM 使用者：返回 RAM 使用者識別碼。當前調用者是角色扮演：返回角色扮演實際委託人 ID。	123456xxxx
Username	string	串連時的使用者名稱。	root
ClientIP	string	遠端連線的客戶 IP。	192.168.1.1
IdentityType	string	身份類型。當前支援的身份類型包括： Account：阿里雲帳號（主帳號）。 RAMUser：RAM 使用者。 AssumedRoleUser：RAM 角色。	RAMUser
SessionId	string	會話 ID。	s-hz023od0x9****
Connections	object
Connection	array<object>	串連資訊列表。
	object	串連資訊。
ClosedReason	string	串連結束原因。僅在狀態（`Status`）為`Disconnected`、`Terminated`、`Failed`時返回該參數。可能值： InstanceNotExists：指定的執行個體不存在或已釋放。 InstanceNotRunning：該執行個體不在運行中。 DeliveryTimeout：連線逾時。 AgentNeedUpgrade：雲助手 Agent 需要升級。 AgentNotOnline：雲助手 Agent 未串連到伺服器。 MessageFormatInvalid：訊息格式不合法。 AgentSocketClosed：串連正常關閉。 ClientClosed：會話管理用戶端關閉了串連。 ReadFromTargetPortFailed：StartTerminalSession 指定 PortNumber 資料轉寄時，從目標連接埠讀取資料時失敗。 ReopenTargetPortFailed：StartTerminalSession 指定 PortNumber 資料轉寄時，重新向目標連接埠發起 TCP 串連失敗。 OpenTargetPortFailed：StartTerminalSession 指定 PortNumber 資料轉寄時，向目標連接埠發起 TCP 串連失敗。 WinptyPermissionDenied：對於 Windows 執行個體，為 winpty.dll 或者 winty-agent.exe 增加指定使用者的可讀可執行許可權失敗。 PasswordNameNotFound：未找到 StartTerminalSession 指定的 PasswordName。 ProcessSessionDataError：處理會話資料失敗。 SessionIdDuplicate：會話 ID 重複。 SessionTimeout：會話逾時（一次會話串連超過 3 小時會主動斷開）。 IdleTimeout：連線逾時（180 秒沒有會話互動，認為串連空閑主動斷開）。 HomeDirPermissionDenied：待串連使用者的 home 目錄許可權不足。 HomeDirNotFound：待串連使用者的 home 目錄不存在。 ShellCommandPermissionDenied：Shell 程式許可權不足（bash、csh 沒有可執行許可權）。 ShellCommandNotFound：Shell 程式不存在（Linux 系統--bash、FreeBSD 系統--csh、Windows 系統--powershell.exe 檔不存在）。 ObtainUserInfoFailed：擷取 Username 參數資訊失敗（家目錄資訊）。 ObtainUserIdentityFailed：擷取 Username 參數鑒權資訊失敗(uid、gid、groups)。 UserNotExists：StartTerminalSession 時指定的 Username 不存在。 MalformedCommandLine：StartTerminalSession 時指定的 CommandLine 解析失敗。	AgentNeedUpgrade
EndTime	string	串連結束時間。	2024-01-19T09:16:46Z
Status	string	工作階段狀態，可能值： Connecting：串連中。 Connected：已串連。 Terminated：會話已終止。 Failed：串連失敗。	Connecting
StartTime	string	串連開始時間。	2024-01-19T09:16:40Z
InstanceId	string	執行個體 ID。	i-bp1i7gg30r52z2em****
FailedDetail	string	串連失敗原因詳情。僅在狀態（Status）為 Failed 時返回該參數。	The Session Manager is closed normally.

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "NextToken": "AAAAAdDWBF2****",
  "Sessions": {
    "Session": [
      {
        "CreationTime": "2024-01-19T09:15:46Z",
        "TargetServer": "192.168.0.246",
        "PortNumber": 22,
        "PrincipalId": "123456xxxx",
        "Username": "root",
        "ClientIP": "192.168.1.1",
        "IdentityType": "RAMUser",
        "SessionId": "s-hz023od0x9****",
        "Connections": {
          "Connection": [
            {
              "ClosedReason": "AgentNeedUpgrade",
              "EndTime": "2024-01-19T09:16:46Z",
              "Status": "Connecting",
              "StartTime": "2024-01-19T09:16:40Z",
              "InstanceId": "i-bp1i7gg30r52z2em****",
              "FailedDetail": "The Session Manager is closed normally."
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.
500	InternalError	An error occurred when you dispatched the request.
403	Operation.Forbidden	The operation is not permitted.
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.

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

變更歷史

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