Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Usage Records/ Exporting the User Session List
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Exporting the User Session List

Function

Exports the user session list.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:session:exportSessions

    Write

    -

    -

    -

    -

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

user_name

No

String

Username.

query_begin_time

No

String

Start time of the search. The session start time serves as the search criterion. Only data within 30 days can be exported. The format is 2024-02-27T03:47:51.182Z: The query_begin_time and query_end_time parameters must either both be provided or both omitted. When omitted, data from the last month is exported.

query_end_time

No

String

End time of the search. The session start time serves as the search criterion. Only data within 30 days can be exported. The format is 2024-02-27T03:47. 51.182Z: The query_begin_time and query_end_time parameters must either both be provided or both omitted. When omitted, data from the last month is exported.

app_server_group_id

No

String

Application streaming server group ID.

vm_ip

No

String

Server IP address.

public_ip

No

String

Egress IP address of the client.

machine_name

No

String

Application streaming server name.

session_state

No

String

Application status. You can query statuses of multiple applications and separate statuses by commas (,).

Active: The session is active. The user has logged in to and is using the session.

Disconnected: The user has logged in, but the session is disconnected.

AppcInit: The session is being initialized.

SignedOut: The session has been logged out of.

InitFail: The session fails to be initialized.

is_success

No

String

Whether the session has been created. If this parameter is left blank, all sessions are queried.

true: successfully created

false: creation failed

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

task_id

String

ID of the export task.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 415

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Success.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

No permissions.

404

Resources not found.

405

The method specified in the request is not allowed.

415

The requested resource format is not supported.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Usage Records