Help Center/ Workspace/ API Reference/ Workspace APIs/ Connection Information/ Querying the Number of Login Users
Updated on 2025-07-14 GMT+08:00

Querying the Number of Login Users

Function

Queries the number of login users. All query parameters cannot be left empty.

Debugging

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

URI

GET /v2/{project_id}/connections/online-users

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

start_time

No

String

Start time of the query. If this parameter is specified, all login records after the specified time are returned. An example format is 2016-08-20T21:11Z. If the end time is not empty, the start time is mandatory. Query by type takes precedence over query by time. Use either query by type or query by time.

end_time

No

String

End time of the query. If this parameter is specified, all login records before the specified time are returned. An example format is 2016-08-20T21:11Z. If the start time is not empty, the end time is mandatory. Query by type takes precedence over query by time. Use either query by type or query by time.

query_type

No

String

Query type. Query by type takes precedence over query by time. Use either query by type or query by time.

  • MONTH: query by month

  • WEEK: query by week

  • DAY: query by day

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.

Content-Type

Yes

String

MIME type of the request body, for example, application/json.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

time_counts

Array of strings

Returns information about previous logins. The query time and count are separated by a colon (:). If the query is performed by day or the time segment is within the same day, the query time is counted by hour. Otherwise, the query time is counted by day.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET v2/8dc9c40a06574a598941b254d4b63b43/connections/online-users?start_time=2020-04-20T03:01Z&end_time=2020-04-20T10:01Z

null

Example Responses

Status code: 200

Response body for querying the number of login users.

{
  "time_counts" : [ "00:00 : 0", "01:00 : 0", "02:00 : 0", "03:00 : 0", "04:00 : 0", "05:00 : 0", "06:00 : 0", "07:00 : 0", "08:00 : 0", "09:00 : 0", "10:00 : 0" ]
}

Status Codes

Status Code

Description

200

Response body for querying the number of login users.

400

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

401

Authentication failed.

403

No operation permissions.

404

No resources 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.