Desktop Statistics

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

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

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

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Status code: 200

**Table 4** 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 5** 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 6** 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 7** 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 8** 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 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
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.