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

Running Status Statistics

Function

Statistics on the running statuses of tenant desktops.

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

    Read

    -

    -

    -

    -

URI

GET /v2/{project_id}/desktops/statistics/run-state

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

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.

Status code: default

Table 3 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/desktops/statistics/run-state

Example Responses

Status code: 200

Response to the request for collecting statistics on the running statuses of desktops.

{
  "stop_num" : 0,
  "active_num" : 5,
  "error_num" : 0,
  "hibernated_num" : 0
}

Status Codes

Status Code

Description

200

Response to the request for collecting statistics on the running statuses of desktops.

default

Error response.

Error Codes

See Error Codes.

Parent topic: Report Statistics