Querying Duration Data of Each Phase of Workspace or Application Streaming
Function
Queries duration data of each phase of Workspace or Application Streaming.
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}/statistics/metrics/access-stages
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
transaction_id |
Yes |
String |
Transaction ID. |
Request 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
Parameter |
Type |
Description |
---|---|---|
username |
String |
Username. |
biz_type |
String |
Access phase. The options are APP (application) and DESKTOP (desktop). |
stages |
Array of UserAccessStage objects |
Details about each access phase. |
Parameter |
Type |
Description |
---|---|---|
stage |
String |
Access phase. The options are LOGIN (login), PRECONNECT (pre-connection), and CONNECT (connection). |
duration |
Integer |
Time consumed, in millisecond. |
is_success |
Boolean |
Whether the access phase is successful. |
start_time |
Long |
Start timestamp. |
end_time |
Long |
End timestamp. |
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
None
Example Responses
Status code: 200
Succeeded.
{ "username" : "user001", "biz_type" : "APP", "stages" : [ { "stage" : "LOGIN", "duration" : 500, "is_success" : true, "start_time" : 1724328355052, "end_time" : 1724328355052, "error_code" : "WKS.00000000", "error_msg" : "OK" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Succeeded. |
400 |
Invalid request from the client. |
401 |
Authentication failed. |
500 |
Internal error. |
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