Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ hotspotSession/ Querying Users Not Migrated from Hotspot Sessions
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Users Not Migrated from Hotspot Sessions

Function

Queries users who are not migrated from hotspot sessions.

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, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/hotspot-session-config/{config_id}/non-migration-users

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

config_id

Yes

String

ID of a hotspot session migration configuration.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

user_name

No

String

Username.

offset

No

Integer

Query offset

limit

No

Integer

Number of records to be queried. Range: 1 to 100.

Request Parameters

Table 3 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Integer

Total number of user IDs that are not migrated during hotspot data migration.

non_migrate_users

Array of UserInfo objects

List of user IDs that were not migrated during hotspot data migration.
Table 5 UserInfo

Parameter

Type

Description

user_id

String

User ID.

user_name

String

Username.

Status code: 400

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: 401

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: 403

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: 404

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: 405

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

GET /v1/a4da8115c9d8464ead3a38309130523f/hotspot-session/d2a3rd115c9ea2b32123sa45hbcf12/non-migration-users

null

Example Responses

Status code: 200

Response to the query of users who are not migrated from hotspot sessions.

{
  "non_migrate_users" : [ {
    "user_id" : "da16f9b8bc9444029cc171a4f7286353",
    "user_name" : "test"
  } ]
}

Status Codes

Status Code

Description

200

Response to the query of users who are not migrated from hotspot sessions.

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.

500

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

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: hotspotSession