更新时间:2025-11-11 GMT+08:00
分享

导出用户会话列表

功能介绍

导出用户会话列表。

调试

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

URI

POST /v1/{project_id}/session/list-sessions/export

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

user_name

String

用户名。

query_begin_time

String

搜索开始时间,以会话开始时间为条件查询,只支持导出30天内数据,格式2024-02-27T03:47:51.182Z,参数中query_begin_time与query_end_time必须同时存在或都不存在,都不存在时导出近一个月的数据。

query_end_time

String

搜索结束时间,以会话开始时间为条件查询,只支持导出30天内数据,格式2024-02-27T03:47:51.182Z,参数中query_begin_time与query_end_time必须同时存在或都不存在,都不存在时导出近一个月的数据。

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' - 会话创建失败

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

task_id

String

导出任务id。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码:405

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码:415

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码:500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码:503

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

响应示例

状态码

状态码

描述

200

成功响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

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

415

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

500

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

503

服务不可用。

错误码

请参见错误码

相关文档