All Products
Search

This Product

    Elastic Desktop Service:DescribeFlowMetric

    Document Center

    Elastic Desktop Service:DescribeFlowMetric

    Last Updated:Mar 19, 2026

    Query the inbound bandwidth and outbound bandwidth of a cloud computer, or the inbound bandwidth and outbound bandwidth for public network access of premium public bandwidth, along with their monitoring data.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    RegionId

    string

    Yes

    The Region ID. You can call DescribeRegions to obtain the list of Regions supported by Elastic Desktop Service (EDS).

    cn-hangzhou

    InstanceId

    string

    Yes

    The instance ID, which can be either a cloud computr ID or a premium public bandwidth plan ID.

    ecd-fwq23f13****或者np-6inxqsvcyv6z8****

    Period

    integer

    Yes

    The statistic period of monitoring data. Unit: seconds.

    Valid values:

    • 60 :

      60 seconds

    • 900 :

      900 seconds

    • 3600 :

      3,600 seconds

    60

    StartTime

    string

    Yes

    Start Time. Supported formats:

    • UNIX timestamp: the number of milliseconds elapsed since January 1, 1970.

    • Format: YYYY-MM-DDThh:mm:ssZ.

    1651817220643

    EndTime

    string

    Yes

    End Time. Supported formats:

    • UNIX timestamp: the number of milliseconds elapsed since January 1, 1970.

    • Format: YYYY-MM-DDThh:mm:ssZ.

    1664714703743

    MetricType

    string

    Yes

    The type of monitoring metric. Supports monitoring data for inbound and outbound bandwidth of cloud computers, as well as inbound and outbound bandwidth for public network access of premium public bandwidth.

    Valid values:

    • intranetInRate :

      The inbound bandwidth for a cloud computer.

    • net_tx.rate :

      The outbound bandwidth for an Internet premium bandwidth plan.

    • intranetOutRate :

      The outbound bandwidth for a cloud computer.

    • net_rx.rate :

      The inbound bandwidth for an Internet premium bandwidth plan.

    intranetOutRate

    InstanceType

    string

    Yes

    The instance type. You can select either cloud computer type or premium public bandwidth type. If you select cloud computer type, the InstanceId and MetricType must be filled in with a cloud computer ID and its corresponding traffic type. The same applies to premium public bandwidth.

    Valid values:

    • desktop :

      Cloud computer

    • network_package :

      Internet premium bandwidth plan

    desktop

    Response elements

    Element

    Type

    Description

    Example

    object

    A collection of response information.

    Data

    string

    Metric data.

    {'instanceId': 'np-4wrye3ishxi47****', 'requestId': '4F0CD5B6-70D6-5115-A2F7-7EAC3981****', 'dataPoints': [{'timeStamp': 1636510320000, 'Average': 293752.0}]}

    RequestId

    string

    The request ID.

    6857EDCB-631F-5405-BE95-45CBB4C3****

    Examples

    Success response

    JSON format

    {
  "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

    Description

    500

    InternalError

    The request processing has failed due to some unknown error, exception or failure.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.