Querying Hotspot Session Migration Configurations

Function

Queries hotspot session migration configurations.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
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
items	Array of HotspotSessionMigrationConfig objects	Hotspot session migration configurations to be queried.

**Table 5** HotspotSessionMigrationConfig
Parameter	Type	Description
id	String	Unique ID.
project_id	String	Project 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

GET /v1/a4da8115c9d8464ead3a38309130523f/hotspot-session-config

null

Example Responses

Status code: 200

Response to the request for querying hotspot session migration configurations.

{
  "items" : [ {
    "id" : "895110260098859008",
    "project_id" : "601xxxx57dfa4e90xxxxxx11c18c8",
    "hotspot_session_migration_enable" : true,
    "hotspot_exit_session_num" : 4,
    "non_migrate_users" : [ {
      "user_id" : "da16f9b8bc9444029cc171a4f7286353",
      "user_name" : "test"
    } ]
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for querying hotspot session migration configurations.
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

Previous topic: Updating Users Not Migrated from Hotspot Sessions

Next topic: Querying Users Not Migrated from Hotspot Sessions

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot