Queries 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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
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. The format is 2016-08-20T21:11Z. If the end time is specified, the start time is mandatory. The type query takes precedence over the time query. Either type query or time query must exist. |
end_time |
No |
String |
End time of the query. If this parameter is specified, all login records before the specified time are returned. The format is 2016-08-20T21:11Z. If the start time is specified, the end time is mandatory. The type query takes precedence over the time query. Either type query or time query must exist. |
query_type |
No |
String |
Query type. The type query takes precedence over the time query. Either type query or time query must exist. -MONTH: query by month -WEEK: query by week -DAY: query by day |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API that is 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
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 405
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 503
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
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 |
You do not have required permissions. |
404 |
No resource found. |
405 |
The request method is not allowed. |
500 |
An internal service error occurred. For details about the error code, see the error code description. |
503 |
The service is unavailable. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot