DescribeFlowMetric - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries the monitoring data of the desktop inbound bandwidth and the desktop outbound bandwidth, or the monitoring data of the workspace bandwidth originated from or destined for the Internet.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
InstanceId	string	Yes	The ID of the instance. The value can be the ID of the cloud desktop or the ID of the Internet access package.	ecd-fwq23f13\\\\ or np-6inxqsvcyv6z8\\\\
Period	integer	Yes	The interval at which monitoring data is collected. Unit: seconds. Enumeration Value: 60 900 3600	60
StartTime	string	Yes	The beginning of the time range to query. The following formats are supported: UNIX timestamp: the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.	1651817220643
EndTime	string	Yes	The end of the time range to query data. The following formats are supported: UNIX timestamp: the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.	1664714703743
MetricType	string	Yes	The type of the monitoring data. The monitoring data includes the inbound bandwidth and the outbound bandwidth of the cloud desktop, or the workspace bandwidth that is originated from or destined for the Internet. Enumeration Value: intranetInRate net_tx.rate intranetOutRate net_rx.rate	intranetOutRate
InstanceType	string	Yes	The type of the instance. You can select a cloud desktop or a network package as an instance. If you select a cloud desktop as an instance, you need to configure the `InstanceId` and `MetricType` parameters. If you select a network package as an instance, you also need to must configure the parameters.	desktop

Response parameters

Parameter	Type	Description	Example
	object	The information that is returned.
Data	string	The monitoring data.	{'instanceId': 'np-4wrye3ishxi47**', 'requestId': '4F0CD5B6-70D6-5115-A2F7-7EAC3981**', 'dataPoints': [{'timeStamp': 1636510320000, 'Average': 293752.0}]}
RequestId	string	The ID of the request.	6857EDCB-631F-5405-BE95-45CBB4C3****

Examples

Sample success responses

JSONformat

{
  "Data": "{'instanceId': 'np-4wrye3ishxi47****', 'requestId': '4F0CD5B6-70D6-5115-A2F7-7EAC3981****', 'dataPoints': [{'timeStamp': 1636510320000, 'Average': 293752.0}]}",
  "RequestId": "6857EDCB-631F-5405-BE95-45CBB4C3****"
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	The request processing has failed due to some unknown error, exception or failure.

For a list of error codes, visit the Service error codes.