Help Center/ Workspace/ API Reference/ Workspace APIs/ Report Statistics/ Desktop Statistics
Updated on 2026-02-10 GMT+08:00
View PDF
Share

Desktop Statistics

Function

Statistics on the statuses of general desktops and desktop pools of a tenant. By default, only the total number is collected.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:statistics:listDesktopStatus

    List

    -

    -

    -

    -

URI

GET /v2/{project_id}/statistics

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

desktop_type

No

Array of strings

Desktop type. If this parameter is left empty, all desktops are queried.

  • DEDICATED: common desktops, including exclusive desktops and dedicated desktops.

  • POOLED: pooled desktop, that is, desktop in a desktop pool.

statistics_type

No

Array of strings

Statistics type. If this parameter is left empty, only the total number of desktops is collected. |- - attach-state: statistics by assignment status; login-state: statistics by login status; run-state: statistics by running status

desktop_pool_ids

No

Array of strings

List of desktop pool IDs to be queried.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number of desktops.

attach_statistics

AttachStatistics object

Assignment statistics.

run_state_statistics

DesktopRunStatisticsRsp object

Operating statistics.

login_state_statistics

DesktopLoginStatisticsRsp object

Login statistics.

desktop_pool_statistics

Array of DesktopPoolStatistics objects

Statistics of each desktop pool. There is a response when desktop_type is set to POOL.
Table 4 DesktopPoolStatistics

Parameter

Type

Description

desktop_pool_id

String

Desktop pool ID.

desktop_pool_name

String

Desktop pool name.

total_num

Integer

Total number of desktops.

attach_statistics

AttachStatistics object

Assignment statistics.

run_state_statistics

DesktopRunStatisticsRsp object

Operating statistics.

login_state_statistics

DesktopLoginStatisticsRsp object

Login statistics.
Table 5 AttachStatistics

Parameter

Type

Description

attached_num

Integer

Number of assigned desktops.

unattached_num

Integer

Number of unassigned desktops.

attaching_num

Integer

Number of desktops being assigned.

attach_error_num

Integer

Number of desktops that fail to be assigned.
Table 6 DesktopRunStatisticsRsp

Parameter

Type

Description

stop_num

Integer

Number of stopped desktops.

active_num

Integer

Number of running desktops.

error_num

Integer

Number of faulty desktops.

hibernated_num

Integer

Number of hibernated desktops.
Table 7 DesktopLoginStatisticsRsp

Parameter

Type

Description

in_use_num

Integer

Number of desktops in use.

unregistered_num

Integer

Number of unregistered desktops.

unable_to_connect_num

Integer

Number of unregistered desktops.

ready_num

Integer

Number of idle desktops.

disconnected_num

Integer

Number of disconnected desktops.

Status code: default

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET /v2/9565be6e740941c493b38a1f46ecae6f/statistics

Example Responses

Status code: 200

Status statistics response.

{
  "total_num" : 1
}

Status Codes

Status Code

Description

200

Status statistics response.

default

Error response.

Error Codes

See Error Codes.

Parent topic: Report Statistics