All Products
Search
Document Center

Elastic Desktop Service:DescribeUserConnectionRecords

Last Updated:Nov 14, 2025

Queries the connection records of an authorized user to cloud computers in a cloud computer pool.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:DescribeUserConnectionRecordsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DesktopGroupIdstringYes

The ID of the cloud computer pool.

dg-2i8qxpv6t1a03****
EndUserIdstringYes

The ID of the authorized user.

alice
EndUserTypestringNo

The type of the user account.

Valid values:

  • SIMPLE: convenience account

  • AD_CONNECTOR: enterprise AD account

SIMPLE
MaxResultsintegerNo

The number of entries to return on each page. Maximum value: 100. Default value: 10.

10
NextTokenstringNo

The token that determines the start point of the next query. If this parameter is empty, all results are returned.

caeba0bbb2be03f84eb48b699f0a4883
ConnectStartTimeFromlongNo

The time when the cloud desktop starts to be connected, which is the minimum value for condition filtering. The value is a UNIX timestamp. Unit: milliseconds.

1631239200000
ConnectStartTimeTolongNo

The time when the cloud desktop starts to be connected, which is the maximum value for condition filtering. The value is a UNIX timestamp. Unit: milliseconds.

1631241000000
ConnectEndTimeFromlongNo

The time when the cloud desktop stops to be connected, which is the minimum value for condition filtering. The value is a UNIX timestamp. Unit: milliseconds.

1631266200000
ConnectEndTimeTolongNo

The time when the cloud desktop stops to be connected, which is the maximum value for condition filtering. The value is a UNIX timestamp. Unit: milliseconds.

1631268000000
ConnectDurationFromlongNo

The duration when the cloud desktop is connected, which is the minimum value for condition filtering.

100
ConnectDurationTolongNo

The duration when the cloud desktop is connected, which is the maximum value for condition filtering.

100
DesktopIdstringNo

The ID of the cloud computer.

ecd-138dsptkrt00u****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

NextTokenstring

The token that is used to start the next query.

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

The ID of the request.

2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03
ConnectionRecordsarray<object>

The connection records.

ConnectionRecordobject

The connection record.

ConnectionRecordIdstring

The ID of the connection record.

528
ConnectStartTimestring

The time when the end user connected to the cloud computer.

2022-01-19T10:12:38Z
DesktopNamestring

The name of the cloud computer to which the end user connected.

testName
ConnectDurationstring

The connection duration. Unit: milliseconds.

3405035000
ConnectEndTimestring

The time when the end user disconnected from the cloud computer.

2022-02-27T20:03:13Z
DesktopIdstring

The ID of the cloud computer to which the end user connected.

ud-2hawufy3uedi1****

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03",
  "ConnectionRecords": [
    {
      "ConnectionRecordId": 528,
      "ConnectStartTime": "2022-01-19T10:12:38Z",
      "DesktopName": "testName",
      "ConnectDuration": 3405035000,
      "ConnectEndTime": "2022-02-27T20:03:13Z",
      "DesktopId": "ud-2hawufy3uedi1****"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history