Query Screen Recording Files via DescribeRecordFile API - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Retrieve screen recording files from all regions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:DescribeRecordFile

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the regions that are supported by Elastic Desktop Service.	cn-shanghai
DesktopId	string	No	The ID of the cloud desktop.	ecd-7w78ozhjcwa3u****
EndUserId	string	No	The ID of the end user.	Alice
StartTime	string	No	The beginning of the time range to query.	20251218175715
EndTime	string	No	The end of the time range to query.	20251218205715
Status	integer	Yes	The status of the screen recording file. Valid values: `0`: The file is uploaded. `1`: The file is being uploaded.	1
RecordType	string	No	The type of the screen recording. Valid values: `alltime`: full-time recording `period`: recording at intervals `event`: event-triggered recording `session`: session-based recording	alltime
OrderBy	string	No	The sorting basis. If you do not specify this parameter, the results are sorted by screen recording start time in descending order. Valid value: `startTime`: the start time of a screen recording.	startTime
OrderSort	string	No	The sorting order. Valid values: `asc`: ascending `desc`: descending	asc
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	20
FileName	string	No	The name of the recording file.	Task7

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	05C2791F-41A7-5E7C-B5E4-1401FD0E****
TotalCount	integer	The total number of records.	2
RecordFiles	array<object>	Details of the screen recording files.
	array<object>	Details of a screen recording file.
Status	integer	The upload status of the screen recording file. Valid values: `0`: uploaded. `1`: uploading.	1
RecordExpire	integer	The expiration time of the screen recording file.	1774656000000
RecordType	integer	The recording type. Valid values: `alltime`: continuous screen recording. `period`: interval screen recording. `event`: event-triggered screen recording. `session`: session-based screen recording.	period
EndUserId	string	The name of the end user.	Alice
RecordEndTime	string	The time when the screen recording ended. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2025-12-18T06:02:25Z
RecordStartTime	string	The time when the screen recording started. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2025-12-18T06:02:25Z
FileName	string	The name of the screen recording file.	Task3
DesktopId	string	The ID of the cloud desktop.	ecd-7yulhw1g1attet7d2
FileSize	integer	The file size. Unit: bytes.	139
EventDetails	array<object>	The event details.
	object	The data object.
EventTime	integer	The time when the event occurred.	60
EventType	string	The event type.	UserInput
EventName	string	The event details.	{\n\t\"messageInfo\" : \"mouse_move\",\n\t\"messageType\" : \"UserInput\"\n}\n"
DesktopName	string	The name of the cloud desktop.	fvt-ecd
PolicyId	string	The ID of the policy.	pg-**
RegionId	string	The ID of the region where the cloud desktop resides.	cn-beijing
ResourceGroupId	string	The ID of the resource group.	rg-f3s3dgt8dtb0vlqc8
ResourceGroupName	string	The name of the resource group.	resource

Examples

Success response

JSON format

{
  "RequestId": "05C2791F-41A7-5E7C-B5E4-1401FD0E****",
  "TotalCount": 2,
  "RecordFiles": [
    {
      "Status": 1,
      "RecordExpire": 1774656000000,
      "RecordType": 0,
      "EndUserId": "Alice",
      "RecordEndTime": "2025-12-18T06:02:25Z",
      "RecordStartTime": "2025-12-18T06:02:25Z",
      "FileName": "Task3",
      "DesktopId": "ecd-7yulhw1g1attet7d2",
      "FileSize": 139,
      "EventDetails": [
        {
          "EventTime": 60,
          "EventType": "UserInput",
          "EventName": "{\\n\\t\\\"messageInfo\\\" : \\\"mouse_move\\\",\\n\\t\\\"messageType\\\" : \\\"UserInput\\\"\\n}\\n\""
        }
      ],
      "DesktopName": "fvt-ecd",
      "PolicyId": "pg-**",
      "RegionId": "cn-beijing",
      "ResourceGroupId": "rg-f3s3dgt8dtb0vlqc8",
      "ResourceGroupName": "resource"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.