All Products
Search

This Product

    Cloud Phone:DescribeMetricTop

    Document Center

    Cloud Phone:DescribeMetricTop

    Last Updated:Dec 04, 2025

    Queries the latest monitoring data for metrics such as instance network bandwidth and returns the results in a sorted list.

    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 syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    MetricNames

    array

    Yes

    The list of metrics.

    string

    No

    The name of the metric.

    Valid values:

    • instance_out_traffic :

      Outbound bandwidth (for standard networks only)

    • instance_in_traffic :

      Inbound bandwidth (for standard networks only)

    instance_in_traffic

    AndroidInstanceIds

    array

    No

    For instance-level monitoring, specify a list of cloud phone instance IDs.

    string

    No

    For instance-level monitoring, specify the cloud phone instance ID.

    acp-sgicbcdadjs****

    Period

    integer

    No

    The statistical period of the monitoring data. Unit: seconds.

    60

    StartTime

    string

    No

    The start time of the query.

    2019-01-31 10:00:00

    EndTime

    string

    No

    The end time of the query.

    2019-01-31 11:00:00

    NextToken

    string

    No

    The token that marks the start of the next page of results. If you leave this parameter empty, the query starts from the beginning.

    AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****

    Length

    string

    No

    The number of entries to return on each page. This parameter is used for paged queries.

    Note

    The maximum value is 100 when the metric is `instance_in_traffic` or `instance_out_traffic`.

    100

    InstanceIds

    array

    No

    The list of instance IDs.

    string

    No

    The instance ID.

    Note

    Specify a bandwidth plan ID to query the top N (where N is less than or equal to 100) bandwidth data points for the plan. The data is sorted by bandwidth in descending order.

    np-5hh4a31emkt6u****

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned.

    RequestId

    string

    The request ID.

    4610632D-D661-5982-B3D7-5D3FD183F****

    Count

    integer

    The number of entries returned.

    1

    NextToken

    string

    The token to retrieve the next page of results. If the results are not fully returned in a single query, this parameter is not empty. You can use this token in a subsequent query to retrieve the next page of results.

    AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****

    MetricTotalModel

    array<object>

    The instance monitoring data.

    array<object>

    The instance monitoring data.

    AndroidInstanceId

    string

    For instance-level monitoring, this is the cloud phone instance ID.

    acp-fkuit0cmyru4p****

    InstanceId

    string

    The instance ID.

    np-5hh4a31emkt6u****

    MetricModelList

    array<object>

    The monitoring data of metrics.

    array<object>

    The monitoring data of metrics.

    MetricName

    string

    The name of the metric.

    instance_in_traffic

    DataPoints

    array<object>

    The monitoring data points.

    object

    A monitoring data point.

    Timestamp

    integer

    The timestamp of the data point. Unit: milliseconds.

    1548777660000

    Minimum

    number

    The minimum value.

    Note

    The unit is bps when the metric is `instance_in_traffic` or `instance_out_traffic`.

    93.1

    Average

    number

    The average value. Unit: %.

    Note

    The unit is bps when the metric is `instance_in_traffic` or `instance_out_traffic`.

    99.52

    Maximum

    number

    The maximum value. Unit: %.

    Note

    The unit is bps when the metric is `instance_in_traffic` or `instance_out_traffic`.

    100

    Name

    string

    The name.

    cloudPhone-****

    Id

    string

    The ID.

    acp-fkuit0cmyru4p****

    Properties

    string

    The properties.

    Note

    A JSON string that contains the extension properties.

    {"IP":"192.168.*.***"}

    Examples

    Success response

    JSON format

    {
  "RequestId": "4610632D-D661-5982-B3D7-5D3FD183F****",
  "Count": 1,
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****",
  "MetricTotalModel": [
    {
      "AndroidInstanceId": "acp-fkuit0cmyru4p****",
      "InstanceId": "np-5hh4a31emkt6u****",
      "MetricModelList": [
        {
          "MetricName": "instance_in_traffic",
          "DataPoints": [
            {
              "Timestamp": 1548777660000,
              "Minimum": 93.1,
              "Average": 99.52,
              "Maximum": 100,
              "Name": "cloudPhone-****",
              "Id": "acp-fkuit0cmyru4p****\n",
              "Properties": "{\"IP\":\"192.168.*.***\"}"
            }
          ]
        }
      ]
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.