All Products
Search
Document Center

Elastic Desktop Service:DescribeOnlineUserCount

Last Updated:May 06, 2026

Queries metrics such as the online user count and the assigned user count.

Operation description

Before you call this operation, make sure that you are familiar with the resource types and product types of Elastic Desktop Service.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

No

The region ID.

cn-hangzhou

SearchRegionId

string

No

The ID of the region to search. This filters the results to show only resources from the specified region.

cn-shanghai

OfficeSiteId

string

No

The office site ID.

cn-shanghai+dir-631324****

BizType

integer

No

Note

This parameter is for internal use only.

1

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The request ID.

269BDB16-2CD8-4865-84BD-11C40BC21DB0

AssignedUserCount

integer

The number of users who have been assigned a cloud desktop.

10

OnlineUserCount

integer

The number of online users. Online users include convenience users and AD users.

1

AdAssignedUserCount

integer

The number of AD users who have been assigned a cloud desktop.

2

SimpleAssignedUserCount

integer

The number of convenience users who have been assigned a cloud desktop.

8

Examples

Success response

JSON format

{
  "RequestId": "269BDB16-2CD8-4865-84BD-11C40BC21DB0",
  "AssignedUserCount": 10,
  "OnlineUserCount": 1,
  "AdAssignedUserCount": 2,
  "SimpleAssignedUserCount": 8
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.