通过DescribeTerminalSessions API查询Session Manager会话历史记录-云服务器 ECS-阿里云

查看Session Manager会话历史记录。

接口说明

支持查看 4 周内创建的 Session Manager 会话记录。

调试

您可以在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	array<object>	会话列表。
Session	object	会话信息。
Connections	array<object>	连接信息列表。
Connection	object	连接信息。
Status	string	会话状态，可能值： Connecting：连接中。 Connected：已连接。 Terminated：会话已终止。 Failed：连接失败。	Connecting
FailedDetail	string	连接失败原因详情。仅在状态（Status）为 Failed 时返回该参数。	The Session Manager is closed normally.
EndTime	string	连接结束时间。	2024-01-19T09:16:46Z
InstanceId	string	实例 ID。	i-bp1i7gg30r52z2em****
StartTime	string	连接开始时间。	2024-01-19T09:16:40Z
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
IdentityType	string	身份类型。当前支持的身份类型包括： Account：阿里云账号（主账号）。 RAMUser：RAM 用户。 AssumedRoleUser：RAM 角色。	RAMUser
PrincipalId	string	身份标识。按照身份类型`IdentityType`，取值如下：当前调用者是阿里云账号：返回阿里云账号 ID。当前调用者是 RAM 用户：返回 RAM 用户 ID。当前调用者是角色扮演：返回角色扮演实际委托人 ID。	123456xxxx
Username	string	连接时的用户名。	root
CreationTime	string	会话的创建时间。	2024-01-19T09:15:46Z
TargetServer	string	通过实例访问 VPC 内的目标服务地址。	192.168.0.246
PortNumber	integer	ECS 实例的端口号，用于数据转发。若未设置数据转发的端口号，则该值为空。	22
ClientIP	string	远程连接的客户 IP。	192.168.1.1
SessionId	string	会话 ID。	s-hz023od0x9****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.	指定的参数NextToken不合法。
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	指定的参数MaxResults不合法。
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.	指定的地域ID不存在。
500	InternalError	An error occurred when you dispatched the request.	发送请求时发生错误，请稍后重试。

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史