全部产品
Search
文档中心

云服务器 ECS:DescribeTerminalSessions - 查看Session Manager会话历史记录

更新时间:Nov 29, 2024

查看Session Manager会话历史记录。

接口说明

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeTerminalSessionslist
*Instance
acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
InstanceIdstring

实例 ID。

i-bp1i7gg30r52z2em****
SessionIdstring

会话 ID。

s-hz023od0x9****
MaxResultsinteger

分页查询时每页的最大条目数。

最大值为 100。

默认值为 10。

10
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

AAAAAdDWBF2****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
NextTokenstring

本次调用返回的查询凭证值。

AAAAAdDWBF2****
Sessionsarray<object>

会话列表。

Sessionobject

会话信息。

CreationTimestring

会话的创建时间。

2024-01-19T09:15:46Z
TargetServerstring

通过实例访问 VPC 内的目标服务地址。

192.168.0.246
PortNumberinteger

ECS 实例的端口号,用于数据转发。若未设置数据转发的端口号,则该值为空。

22
PrincipalIdstring

身份标识。按照身份类型IdentityType,取值如下:

  • 当前调用者是阿里云账号:返回阿里云账号 ID。
  • 当前调用者是 RAM 用户:返回 RAM 用户 ID。
  • 当前调用者是角色扮演:返回角色扮演实际委托人 ID。
123456xxxx
Usernamestring

连接时的用户名。

root
ClientIPstring

远程连接的客户 IP。

192.168.1.1
IdentityTypestring

身份类型。当前支持的身份类型包括:

  • Account:阿里云账号(主账号)。
  • RAMUser:RAM 用户。
  • AssumedRoleUser:RAM 角色。
RAMUser
SessionIdstring

会话 ID。

s-hz023od0x9****
Connectionsarray<object>

连接信息列表。

Connectionobject

连接信息。

ClosedReasonstring

连接结束原因。 仅在状态(Status)为DisconnectedTerminatedFailed时返回该参数。可能值:

  • InstanceNotExists:指定的实例不存在或已释放。
  • InstanceNotRunning:该实例不在运行中。
  • DeliveryTimeout:连接超时。
  • AgentNeedUpgrade:云助手 Agent 需要升级。
  • AgentNotOnline:云助手 Agent 未连接到服务器。
  • MessageFormatInvalid:消息格式不合法。
  • AgentSocketClosed:连接正常关闭。
  • ClientClosed:会话管理客户端关闭了连接。
AgentNeedUpgrade
EndTimestring

连接结束时间。

2024-01-19T09:16:46Z
Statusstring

会话状态,可能值:

  • Connecting:连接中。
  • Connected:已连接。
  • Terminated:会话已终止。
  • Failed:连接失败。
Connecting
StartTimestring

连接开始时间。

2024-01-19T09:16:40Z
InstanceIdstring

实例 ID。

i-bp1i7gg30r52z2em****

示例

正常返回示例

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****"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

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