Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ hotspotSession/ Creating Hot Session Migration Configurations
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Creating Hot Session Migration Configurations

Function

Creates a hotspot session migration configuration.

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

POST /v1/{project_id}/hotspot-session-config

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

hotspot_session_migration_enable

Yes

Boolean

Whether to enable hotspot session migration. The options are:

false: disabled

true: enabled

hotspot_exit_session_num

Yes

Integer

Number of sessions that exited from a hotspot.

non_migrate_users

No

Array of UserInfo objects

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

Parameter

Mandatory

Type

Description

user_id

No

String

User ID.

user_name

No

String

Username.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

Unique ID.

hotspot_session_migration_enable

Boolean

Whether to enable hotspot session migration. The options are:

false: disabled

true: enabled

hotspot_exit_session_num

Integer

Number of sessions that exited from a hotspot.

non_migrate_users

Array of UserInfo objects

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

Parameter

Type

Description

user_id

String

User ID.

user_name

String

Username.

Status code: 400

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

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

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

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

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

Table 12 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 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

POST /v1/a4da8115c9d8464ead3a38309130523f/hotspot-session-config

null

Example Responses

Status code: 200

Success.

{
  "hotspot_session_migration_enable" : true,
  "hotspot_exit_session_num" : 2,
  "non_migrate_users" : [ {
    "user_id" : "da16f9b8btest029cc171a4f7286353",
    "user_name" : "test"
  } ]
}

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.

500

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

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: hotspotSession