Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Server Management/ Querying Monitoring Information of an Application Streaming Server

Updated on 2026-05-21 GMT+08:00

Querying Monitoring Information of an Application Streaming Server

Function

Queries data (such as the CPU usage, memory usage, and period when a user is online) of a desktop in a time range (from 1 hour to 30 days). The data can be retained for up to 180 days.

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:server:getMetricData	Read	server *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	-

URI

GET /v1/{project_id}/app-servers/metric-data/{server_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Unique ID of a project
server_id	Yes	String	Unique ID of a server.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
start_time	Yes	String	Monitoring start time. The value is in UTC format, for example, 2021-05-11T11:45:42.000Z.
end_time	Yes	String	Monitoring end time. The value is in UTC format, for example, 2021-05-11T11:45:42.000Z.
metric_name	No	String	Monitoring metrics, for example, cpu_util. For details, see the following table. If metric_name is left empty, batch query is performed. \| Metric \| Metric Name \| Monitored Object \| Monitoring Period \|\| ------------------------------------- \| ----------------- \| ------------ \| -------- \|\| cpu_util \| CPU usage \| ECS \| 5 min \|\| mem_util \| Memory usage \| ECS \| 5 min \|\| disk_util_inband \| Disk usage \| ECS \| 5 min \|\| disk_read_bytes_rate \| Disk read bandwidth \| ECS \| 5 min \|\| disk_write_bytes_rate \| Disk write bandwidth \| ECS \| 5 min \|\| disk_read_requests_rate \| Disk read IOPS \| ECS \| 5 min \|\| disk_write_requests_rate \| Disk write IOPS \| ECS \| 5 min \|\| network_incoming_bytes_rate_inband \| Inband incoming rate \| ECS \| 5 min \|\| network_outgoing_bytes_rate_inband \| Inband outgoing rate \| ECS \| 5 min \|\| network_incoming_bytes_aggregate_rate \| Outband incoming rate \| ECS \| 5 min \|\| network_outgoing_bytes_aggregate_rate \| Outband outgoing rate \| ECS \| 5 min \|

Request Parameters

**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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
cpu_info	Array of DataPoints objects	CPU usage.
memory_info	Array of DataPoints objects	Memory usage information.
disk_util_inband	Array of DataPoints objects	Disk Usage.
disk_read_bytes_rate	Array of DataPoints objects	Disk Read Bandwidth.
disk_write_bytes_rate	Array of DataPoints objects	Disk write bandwidth.
disk_read_requests_rate	Array of DataPoints objects	Disk Read IOPS.
disk_write_requests_rate	Array of DataPoints objects	Disk Write IOPS.
network_incoming_bytes_rate_inband	Array of DataPoints objects	Inband Incoming Rate.
network_outgoing_bytes_rate_inband	Array of DataPoints objects	Inband Outgoing Rate.
network_incoming_bytes_aggregate_rate	Array of DataPoints objects	Outband Incoming Rate.
network_outgoing_bytes_aggregate_rate	Array of DataPoints objects	Outband outgoing rate.
network_vm_connections	Array of DataPoints objects	Network Connections.

**Table 5** DataPoints
Parameter	Type	Description
average	Double	Average value.
timestamp	Long	Timestamp.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 405

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 503

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Example Requests

None

Example Responses

Status code: 200

Successful.

{
  "cpu_info" : [ {
    "average" : 0.4832775919732441,
    "timestamp" : 1618810632000
  }, {
    "average" : 0.4832775919732441,
    "timestamp" : 1618810931000
  }, {
    "average" : 0.5018382352941176,
    "timestamp" : 1618811203000
  }, {
    "average" : 0.4830508474576271,
    "timestamp" : 1618812396000
  } ],
  "disk_read_bytes_rate" : [ {
    "average" : 0.4832775919732441,
    "timestamp" : 1618810632000
  } ],
  "memory_info" : [ {
    "average" : 12.501838235294118,
    "timestamp" : 1618811203000
  }, {
    "average" : 12.483050847457626,
    "timestamp" : 1618812396000
  } ],
  "disk_util_inband" : [ {
    "average" : 12.483050847457626,
    "timestamp" : 1618812396000
  } ],
  "disk_write_bytes_rate" : [ {
    "average" : 12.483050847457626,
    "timestamp" : 1618812396000
  } ],
  "disk_read_requests_rate" : [ {
    "average" : 12.48,
    "timestamp" : 1618812396000
  } ],
  "network_outgoing_bytes_rate_inband" : [ {
    "average" : 170.5190311418685,
    "timestamp" : 1618812396000
  } ],
  "network_incoming_bytes_aggregate_rate" : [ {
    "average" : 158.4299674267101,
    "timestamp" : 1618812396000
  } ],
  "network_outgoing_bytes_aggregate_rate" : [ {
    "average" : 144.38275862068966,
    "timestamp" : 1618812396000
  } ]
}

Status Codes

Status Code	Description
200	Successful.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	Permissions required.
404	No resources found.
405	The request method is not allowed.
500	An internal service error occurred. For details, see the error code description.
503	Service unavailable.

Error Codes

See Error Codes.

Parent topic: Server Management

Previous topic: Querying HDA Upgrade Tracing Records of a Server

Next topic: Querying the Monitoring Data of a Metric of a Specified Granularity in a Specified Time Range

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot