Query session statistics using DescribeSessionStatistic - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Operation description

This is a central operation and can be called only by using services in the China (Shanghai) region.
You can query session statistics for the past hour.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
SearchRegionId	string	No	Specifies to search for session information by region ID. This parameter is used to filter desktop information of a specific region.	cn-hangzhou
OfficeSiteId	string	No	The workspace ID.	cn-shanghai+dir-259382****
StartTime	string	No	The beginning of the time range to query.	1679449506572
EndTime	string	No	The end of the time range to query.	1677808889806
Period	integer	No	The query interval. Unit: seconds. Valid values: 60 120	60

Response elements

Element	Type	Description	Example
	object
TotalCount	string	The total number of sessions returned.	1
RequestId	string	The request ID.	C5528624-C6ED-5CA4-A4A2-7C30DBF2****
Statistic	array<object>	The statistics.
	object
TimePoint	integer	The point in time.	1690164443508
Count	integer	The total number of sessions in the time range.	4

Examples

Success response

JSON format

{
  "TotalCount": "1",
  "RequestId": "C5528624-C6ED-5CA4-A4A2-7C30DBF2****",
  "Statistic": [
    {
      "TimePoint": 1690164443508,
      "Count": 4
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.