DescribeUserConnectionRecords-阿里云帮助中心

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

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:DescribeUserConnectionRecords

get

*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 most recent region list.	cn-hangzhou
DesktopGroupId	string	Yes	The ID of the computer pool.	dg-2i8qxpv6t1a03****
EndUserId	string	Yes	The ID of the authorized user.	alice
EndUserType	string	No	The type of the user account. Valid values: SIMPLE: convenience account AD_CONNECTOR: enterprise AD account Valid values: SIMPLE : AD_CONNECTOR :	SIMPLE
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
NextToken	string	No	The token that determines the start point of the next query. If this parameter is empty, all results are returned.	caeba0bbb2be03f84eb48b699f0a4883
ConnectStartTimeFrom	integer	No	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
ConnectStartTimeTo	integer	No	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
ConnectEndTimeFrom	integer	No	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
ConnectEndTimeTo	integer	No	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
ConnectDurationFrom	integer	No	The duration when the cloud desktop is connected, which is the minimum value for condition filtering.	100
ConnectDurationTo	integer	No	The duration when the cloud desktop is connected, which is the maximum value for condition filtering.	100
DesktopId	string	No	The ID of the cloud computer.	ecd-138dsptkrt00u****

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	The token that is used to start the next query.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The ID of the request.	2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03
ConnectionRecords	array<object>	The connection records.
	object	The connection record.
ConnectionRecordId	string	The ID of the connection record.	528
ConnectStartTime	string	The time when the end user connected to the cloud computer.	2022-01-19T10:12:38Z
DesktopName	string	The name of the cloud computer to which the end user connected.	demoComputer
ConnectDuration	string	The connection duration. Unit: milliseconds.	1800000
ConnectEndTime	string	The time when the end user disconnected from the cloud computer.	2022-02-27T20:03:13Z
DesktopId	string	The ID of the cloud computer to which the end user connected.	ecd-gx2x1dhsmucyy****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.