Querying Key Desktop Events

Function

Queries key desktop events.

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}/screen-records/{record_id}/os-operations

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
record_id	Yes	String	UUID of a screen recording record.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
event_type	No	String	Event type. APP: application monitoring FILE: file monitoring REG: registry monitoring HDP: protocol behavior monitoring
event_id	No	String	Event ID. APP_START: application startup APP_STOP: application termination APP_CRASH: abnormal application exit APP_HANG: no application response APP_INSTALL: application installation APP_UNINSTALL: application uninstallation FILE_CREATE: file creation FILE_DELETE: file deletion FILE_RENAME: file renaming HDP_FILE: file redirection HDP_USB: USB device insertion or removal HDP_CLIPBOARD: clipboard operation HDP_INPUTIDLE: idle HDP_PRINT: file printing
event_level	No	String	Event severity. INFO: Information ALARM: Alarm ERROR: Error
event_data	No	String	Event content.
limit	No	Integer	Limits the quantity of returned desktops in pagination query. The value ranges from 0 to 100. The default value is 10.
offset	No	Integer	Where the pagination query starts. The value starts from 0.

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 that is 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
operations	Array of OperationForList objects	Operation record.
total_count	Integer	Total number.

**Table 5** OperationForList
Parameter	Type	Description
id	String	Primary key UUID.
project_id	String	Project ID.
desktop_id	String	Desktop ID.
screen_record_id	String	Screen recording record ID.
username	String	Username.
event_type	String	Event type. APP: application monitoring FILE: file monitoring REG: registry monitoring HDP: protocol behavior monitoring
event_level	String	Event severity. INFO: Information ALARM: Alarm ERROR: Error
event_id	String	Event ID. APP_START: application startup APP_STOP: application termination APP_CRASH: abnormal application exit APP_HANG: no application response APP_INSTALL: application installation APP_UNINSTALL: application uninstallation FILE_CREATE: file creation FILE_DELETE: file deletion FILE_RENAME: file renaming HDP_FILE: file redirection HDP_USB: USB device insertion or removal HDP_CLIPBOARD: clipboard operation HDP_INPUTIDLE: idle HDP_PRINT: file printing
event_data	String	Event content.
operation_time	String	Operation time (2024-10-15T11:04:41.263Z).
relative_start_time	Integer	Time (in seconds) relative to the video start time.

Status code: 400

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

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

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

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

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

**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.

Status code: 503

**Table 12** 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/089b2f9a3d80d3062f24c00ca4ed5cbd/6c655e6a-xxxx-xxxx-xxxx-b7f0edc7a082/os-operations

Example Responses

Status code: 200

Queries key desktop events.

{
  "total_count" : 2,
  "operations" : [ {
    "id" : "8ac225c2781f230a01781f29b2e7xxxx",
    "desktop_id" : "7f1ac068-xxxx-xxxx-xxxx-535f4b315958",
    "screen_record_id" : "7f1ac068-xxxx-xxxx-xxxx-535f4b31111",
    "username" : "chenxxx",
    "event_type" : "APP",
    "event_level" : "Information",
    "event_id" : "APP_START",
    "event_data" : "WeLink is started.",
    "operation_time" : "2024-03-12 12:02:01",
    "relative_start_time" : 16
  }, {
    "id" : "8ac225c2781edb0d01781edde3f4xxxx",
    "desktop_id" : "7f1ac068-xxxx-xxxx-xxxx-535f4b315959",
    "screen_record_id" : "7f1ac068-xxxx-xxxx-xxxx-535f4b32222",
    "username" : "wanghaha",
    "event_type" : "FILE",
    "event_level" : "Error",
    "event_id" : "FILE_DELETE",
    "event_data" : "File deletion",
    "operation_time" : "2024-03-12 12:02:01",
    "relative_start_time" : 16
  } ]
}

Status Codes

Status Code	Description
200	Queries key desktop events.
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 about the error code, see the error code description.
503	Service unavailable.