查询用户会话列表 - ListSessions

功能介绍

查询用户会话列表。

调试

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
workspace:session:listSessions
List
-
-
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
workspace:session:listSessions	List	-	-	-	-

URI

GET /v1/{project_id}/session/list-sessions

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	单次查询的大小[1-100]，默认值10。
offset	否	Integer	查询的偏移量，默认值0。
user_name	否	String	用户名。
query_begin_time	是	String	搜索开始时间，以会话开始时间为条件查询，格式2024-02-27T03:47:51.182Z。
query_end_time	是	String	搜索结束时间，以会话开始时间为条件查询，格式2024-02-27T03:47:51.182Z。
app_server_group_id	否	String	AppServer组ID。
vm_ip	否	String	服务器IP。
public_ip	否	String	客户端出口IP。
machine_name	否	String	应用服务器名称。
session_state	否	String	应用状态，支持查询多个，中间用英文逗号分隔： Active - 会话当前处于活动状态，有用户登录并且正在使用。 Disconnected - 用户已经登录但会话处于断开连接状态。 AppcInit - 会话正在初始化。 SignedOut - 会话已注销。 InitFail - 会话初始化失败。
is_success	否	String	会话是否创建成功,默认不填则查询全部 'true' - 会话创建成功 'false' - 会话创建失败

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
count	Integer	总数。
items	Array of SessionInfo objects	企业的会话列表。

表5 SessionInfo
参数	参数类型	描述
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_server_group_id	String	AppServer组ID。
app_server_group_name	String	AppServer组名称。
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。
primary_server_group_id	String	主服务器组ID。
secondary_server_group_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/list-sessions?limit=10&offset=0&query_end_time=2024-02-28T17:47:51.182Z&query_begin_time=2024-02-26T03:47:51.182Z

响应示例

状态码：200

成功响应。

{
  "count" : 20,
  "items" : [ {
    "id" : "0a0666f634a54131826bf688058d0bc6",
    "session_stamp" : "S-1-5-21-1908276142-124560728-768171367-3204-XXXXX@wksapp.huawei.com-HDP-2",
    "protocol_type" : "HDP",
    "login_user" : "XXX@wksapp.huawei.com",
    "session_type" : "2",
    "app_server_group_id" : "e75fef51-bbb7-489c-b4bd-63e0587faa41",
    "app_server_group_name" : "TEST-勿动",
    "pre_conn_time" : "2024-03-13T03:12:47Z",
    "start_time" : "2024-03-13T03:12:47Z",
    "machine_sid" : "S-1-5-21-1908276142-124560728-768171367-3204",
    "machine_name" : "APS-CUY5MR45XX",
    "session_state" : "AppcInit",
    "agent_version" : "23.5.0.0606",
    "vm_ip" : "172.*.*.218",
    "failed_reason" : "",
    "failed_code" : "",
    "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011"
  } ]
}

状态码

状态码	描述
200	成功响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
405	请求中指定的方法不被允许。
415	请求中提交的资源格式不支持。
500	服务内部错误，具体返回错误码请参见错误码说明。
503	服务不可用。