导出用户会话列表 - ExportSessions
功能介绍
导出用户会话列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
workspace:session:exportSessions
Write
-
-
-
-
URI
POST /v1/{project_id}/session/list-sessions/export
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 否 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
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 | 应用状态,支持查询多个,中间用英文逗号分隔:
|
is_success | 否 | String | 会话是否创建成功,默认不填则查询全部
|
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
task_id | String | 导出任务id。 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码,失败时返回。 |
error_msg | String | 错误描述。 |
状态码:401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码,失败时返回。 |
error_msg | String | 错误描述。 |
状态码:403
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码,失败时返回。 |
error_msg | String | 错误描述。 |
状态码:404
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码,失败时返回。 |
error_msg | String | 错误描述。 |
状态码:405
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码,失败时返回。 |
error_msg | String | 错误描述。 |
状态码:415
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码,失败时返回。 |
error_msg | String | 错误描述。 |
状态码:500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码,失败时返回。 |
error_msg | String | 错误描述。 |
状态码:503
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码,失败时返回。 |
error_msg | String | 错误描述。 |
请求示例
无
响应示例
无
状态码
状态码 | 描述 |
|---|---|
200 | 成功响应。 |
400 | 由于包含语法错误,当前请求无法被服务器理解。 |
401 | 鉴权失败。 |
403 | 没有操作权限。 |
404 | 找不到资源。 |
405 | 请求中指定的方法不被允许。 |
415 | 请求中提交的资源格式不支持。 |
500 | 服务内部错误,具体返回错误码请参见错误码说明。 |
503 | 服务不可用。 |
错误码
请参见错误码。

