Querying Screen Recording Records

Function

Queries screen recording records.

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
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.
desktop_id	No	String	Filters results by desktop ID.
username	No	String	Filters results by username.
status	No	String	Screen recording status. RECORDING: being recorded REC_COMPLETED: recording completed UPLOADING: recording being uploaded UPLOAD_COMPLETED: upload completed
type	No	String	Screen recording type. FULL: continuous screen recording INTERVAL: interval-based screen recording OPERATION: screen recording triggered by a specific user operation SESSION: screen recording of the session lifecycle
start_time	No	String	Start time. The format is yyyy-MM-dd HH:mm:ss (UTC time. If this parameter is not specified, data of the last 15 days is queried by default).
end_time	No	String	End time. The format is yyyy-MM-dd HH:mm:ss (UTC time. If this parameter is not specified, data of the last 15 days is queried by default).
sort_field	No	String	Field used for sorting the query results. The value is the start_time field of the screen recording attribute.
sort_type	No	String	Whether the query results are sorted in ascending or descending order. Its value can be desc or asc. This parameter is used together with sort_field.

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
screen_records	Array of ScreenRecordDetail objects	Screen recording record.
total_count	Integer	Total number.

**Table 5** ScreenRecordDetail
Parameter	Type	Description
id	String	Primary key UUID.
desktop_id	String	Desktop ID.
desktop_name	String	Desktop name.
desktop_pool_id	String	Desktop pool ID.
username	String	Username.
size	Integer	File size, in bytes.
type	String	Screen recording type. FULL: continuous screen recording INTERVAL: interval-based screen recording OPERATION: screen recording triggered by a specific user operation SESSION: screen recording of the session lifecycle
status	String	Screen recording status. RECORDING: being recorded REC_COMPLETED: recording completed REC_FAILED: recording failed UPLOADING: recording being uploaded UPLOAD_COMPLETED: upload completed UPLOAD_FAILED: upload failed
policy_id	String	Specifies the policy ID.
obs_bucket	String	OBS bucket name.
file_directory	String	File directory.
video_filename	String	Screen recording file name.
video_file_sha256	String	SHA-256 of a screen recording file.
event_filename	String	Event file name.
event_file_sha256	String	SHA-256 of an event file.
start_time	String	Start time (2024-10-15T10:04:41.263Z).
end_time	String	End time (2024-10-15T11:04:41.263Z).
update_time	String	Update time (2024-10-15T11:04:41.263Z).
duration	Integer	Video duration, in seconds.

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/screen-records

Example Responses

Status code: 200

Response to the request for querying screen recording records.

{
  "total_count" : 2,
  "screen_records" : [ {
    "id" : "8ac225c2781f230a01781f29b2e7xxxx",
    "desktop_id" : "7f1ac068-xxxx-xxxx-xxxx-535f4b315958",
    "desktop_name" : "desktop01",
    "desktop_pool_id" : "3cjh2068-xxxx-xxxx-xxxx-535f4b315364",
    "username" : "chenxxx",
    "status" : "Uploaded",
    "type" : "Continuous screen recording",
    "size" : 546,
    "video_filename" : "video_089b2f9a3d80d3062f24c00ca4ed5cbd_wanghaha_xxxxx.mp4",
    "event_filename" : "video_089b2f9a3d80d3062f24c00ca4ed5cbd_wanghaha_xxxxx.mp4",
    "start_time" : "2024-03-12 12:02:01",
    "end_time" : "2024-03-12 12:52:01",
    "update_time" : "2024-03-12 12:58:34",
    "duration" : 3000
  }, {
    "id" : "8ac225c2781edb0d01781edde3f4xxxx",
    "desktop_id" : "7f1ac068-xxxx-xxxx-xxxx-535f4b315959",
    "desktop_name" : "desktop02",
    "desktop_pool_id" : "d3b82068-xxxx-xxxx-xxxx-535f4b315f3j",
    "username" : "wanghaha",
    "status" : "Uploaded",
    "type" : "Interval-based screen recording",
    "size" : 639,
    "video_filename" : "video_089b2f9a3d80d3062f24c00ca4ed5cbd_wanghaha_yyyyy.mp4",
    "event_filename" : "video_089b2f9a3d80d3062f24c00ca4ed5cbd_wanghaha_yyyyy.mp4",
    "start_time" : "2024-09-30 11:02:06",
    "end_time" : "2024-09-30 12:02:26",
    "update_time" : "2024-09-30 13:06:12",
    "duration" : 3620
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for querying screen recording records.
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.