文档首页/云桌面 Workspace/API参考/云应用API/使用记录/根据用户名查询当前会话 - ListSessionByUserName
更新时间：2025-12-29 GMT+08:00
查看PDF
分享

根据用户名查询当前会话 - ListSessionByUserName

功能介绍

根据用户名查询当前会话。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    workspace:session:listSessionByUserName

    List

    -

    -

    -

    -

URI

GET /v1/{project_id}/session/user-session-info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

user_name

是

String

用户名。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

session_info_list

Array of AppSession objects

会话信息列表。

表5 AppSession

参数

参数类型

描述

id

String

主键ID。

session_stamp

String

会话标识。

os_session_id

String

会话在hda的os中会话id。

protocol_type

String

协议类型。

login_user

String

当前会话的登录用户。

session_type

String

会话类型，1表示共享桌面，2表示应用。

app_group_id

String

App组ID。

app_server_group_id

String

AppServer组ID。

pre_conn_time

String

预连接时间。

start_time

String

会话开始时间。

end_time

String

会话结束时间。

status_continue_time

String

状态持续时间。

machine_sid

String

服务器SID。。

machine_name

String

服务器名称。

session_state

String

会话状态。

app_name

String

会话中的应用名称。

client_mac

String

客户端Mac地址。

client_name

String

客户端名称。

client_ip

String

客户端IP。

public_ip

String

客户端出口ip。

client_version

String

客户端版本。

client_type

String

客户端类型。

agent_version

String

agent版本。

vm_ip

String

服务器IP。

failed_reason

String

错误原因消息。

failed_code

String

错误原因码。

last_update_status_time

String

状态最后变化时间。

tenant_id

String

租户ID。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：405

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：415

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：503

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

GET /v1/a4da8115c9d8464ead3a38309130523f/session/user-session-info?user_name=user001

响应示例

状态码：200

成功响应。

{
  "session_info_list" : [ {
    "id" : "a7db732e1ad511edaf56fa163ed8e03f",
    "session_stamp" : "S-1-5-21-1908276142-124560728-768171367-1358-zeng**long@wksapp.****huawei.com-HDP-_1",
    "protocol_type" : "Hdp",
    "login_user" : "zeng**long@wksapp.****huawei.com",
    "session_type" : "1",
    "pre_conn_time" : "2022-08-13 07:00:20",
    "start_time" : "2022-08-13 07:00:20",
    "end_time" : "0001-01-01 00:00:00",
    "machine_sid" : "S-1-5-21-1908276142-**4560728-768171367-1358",
    "session_state" : "AppcInit",
    "client_mac" : "3c-7c-3f-**-e4-04",
    "client_name" : "proven",
    "client_ip" : "10.**.**.239",
    "client_version" : "22.4.2.12888",
    "client_type" : "Windows 10 Enterprise",
    "agent_version" : "21.12.0.11461",
    "vm_ip" : "172.**.**.26",
    "failed_reason" : "success",
    "failed_code" : "WKS.00000000",
    "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011"
  }, {
    "id" : "9d123d5e0f36419c9b345efcd031a92e",
    "session_stamp" : "S-1-5-21-1908276142-124560728-768171367-3006-zeng**long@wksapp.****huawei.com-HDP-2",
    "os_session_id" : "2",
    "protocol_type" : "Hdp",
    "login_user" : "zeng**long@wksapp.****huawei.com",
    "session_type" : "2",
    "app_group_id" : "587004825166675968",
    "app_server_group_id" : "fb8a92be-ebc1-4dac-9a4c-1590518d140a",
    "pre_conn_time" : "2023-07-07 03:04:06",
    "start_time" : "2023-07-07 03:04:06",
    "end_time" : "0001-01-01 00:00:00",
    "machine_sid" : "S-1-5-21-1908276142-***560728-768171367-3006",
    "machine_name" : "APS-6NGU98Y4W4",
    "session_state" : "AppcInit",
    "app_name" : "HDTransmission,winlogon,HDTerminalExplorer,slui,HDTerminalAssist,fontdrvhost,TSTheme,ChsIME,ctfmon,csrss,HDTerminalSystem,dwm,ChsIME,sihost,HDTerminalDisplay,TabTip32,svchost,svchost,HDTerminalUser,taskhostw,TabTip",
    "client_mac" : "3c-7c-3f-**-e4-04",
    "client_name" : "proven",
    "client_ip" : "10.*.97.212",
    "client_version" : "23.2.2.0",
    "client_type" : "Windows 10 Enterprise",
    "agent_version" : "23.2.0.0314",
    "vm_ip" : "172.*.*.41",
    "failed_reason" : "success",
    "failed_code" : "WKS.00000000",
    "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011"
  } ]
}

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

415

请求中提交的资源格式不支持。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题：使用记录

相关文档