本文导读

功能介绍
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 录屏审计/ 查询录屏记录列表

查询录屏记录列表

更新时间：2025-07-09 GMT+08:00

查看PDF

功能介绍

查询录屏记录列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/screen-records

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	用于分页查询，返回录屏记录数量的限制。默认100。范围0~1000。
offset	否	Integer	用于分页查询，查询的起始记录序号，从0开始。
desktop_id	否	String	根据桌面ID过滤结果。
username	否	String	根据用户名称过滤结果。
status	否	String	录屏状态。 RECORDING：录制中。 REC_COMPLETED：录制完成。 UPLOADING：上传中。 UPLOAD_COMPLETED：上传完成。
type	否	String	录屏类型。 FULL：全程录屏。 INTERVAL：间隔录屏。 OPERATION：用户操作录屏。 SESSION：监听会话生命周期录屏。
start_time	否	String	开始时间，格式为yyyy-MM-dd HH:mm:ss（UTC时间，不传查默认最近15天）。
end_time	否	String	结束时间，格式为yyyy-MM-dd HH:mm:ss（UTC时间，不传查默认最近15天）。
sort_field	否	String	用于排序，表示按照哪个字段排序。取值为录屏属性start_time字段。
sort_type	否	String	用于排序，表示升序还是降序，取值为asc和desc。与sort_field一起组合使用。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
screen_records	Array of ScreenRecordDetail objects	录屏记录。
total_count	Integer	总数。

表5 ScreenRecordDetail
参数	参数类型	描述
id	String	主键UUID。
desktop_id	String	桌面ID。
desktop_name	String	桌面名称。
desktop_pool_id	String	桌面池ID。
username	String	用户名称。
size	Integer	文件大小（Byte）。
type	String	录屏类型。 FULL：全程录屏。 INTERVAL：间隔录屏。 OPERATION：用户操作录屏。 SESSION：监听会话生命周期录屏。
status	String	录屏状态。 RECORDING：录制中。 REC_COMPLETED：录制完成。 REC_FAILED：录制失败。 UPLOADING：上传中。 UPLOAD_COMPLETED：上传完成。 UPLOAD_FAILED：上传失败。
policy_id	String	策略ID。
obs_bucket	String	OBS桶名称。
file_directory	String	文件目录。
video_filename	String	录屏文件名称。
video_file_sha256	String	录屏文件sha256。
event_filename	String	事件文件名称。
event_file_sha256	String	事件文件sha256。
start_time	String	开始时间（2024-10-15T10:04:41.263Z）。
end_time	String	结束时间（2024-10-15T11:04:41.263Z）。
update_time	String	更新时间（2024-10-15T11:04:41.263Z）。
duration	Integer	视频时长（秒）。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：405

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：503

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

GET /v2/089b2f9a3d80d3062f24c00ca4ed5cbd/screen-records

响应示例

状态码：200

查询录屏记录列表的响应。

{
  "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" : "已上传",
    "type" : "全程录屏",
    "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" : "已上传",
    "type" : "间隔录屏",
    "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
  } ]
}

状态码


状态码	描述
200	查询录屏记录列表的响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
405	请求中指定的方法不被允许。
500	服务内部错误，具体返回错误码请参见错误码说明。
503	服务不可用。

错误码

请参见错误码。

父主题： 录屏审计

上一篇：录屏审计

下一篇：查询录屏详情

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消