All Products
Search

This Product

    Cloud Phone:DescribeMetricList

    Document Center

    Cloud Phone:DescribeMetricList

    Last Updated:Dec 04, 2025

    Queries monitoring data for specified metrics, such as network bandwidth.

    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

    MetricNames

    array

    Yes

    The monitoring metrics.

    string

    No

    The name of the metric.

    Valid values:

    • cpu_utilization :

      CPU utilization

    • bandwidth_package_usage_out :

      Outbound bandwidth of the bandwidth plan (for standard networks only)

    • diskusage_utilization :

      Storage usage

    • memory_used_utilization :

      Memory usage

    • intranet_out_rate :

      Outbound bandwidth of the connection

    • gpu_memory_used_utilization :

      GPU memory usage (for matrices only)

    • bandwidth_package_usage_in :

      Inbound bandwidth of the bandwidth plan (for standard networks only)

    • process_memory :

      Process memory usage

    • intranet_in_rate :

      Inbound bandwidth of the connection

    • process_cpu :

      Process CPU utilization

    • gpu_used_utilization :

      GPU usage (for matrices only)

    bandwidth_package_usage_in

    AndroidInstanceIds

    array

    No

    For instance-level monitoring, enter a list of Cloud Phone instance IDs.

    string

    No

    For instance-level monitoring, enter a Cloud Phone instance ID.

    cpn-25nt4kk9whhok****

    InstanceIds

    array

    No

    A list of instance IDs.

    string

    No

    The instance ID.

    Note

    Enter a bandwidth plan ID to query bandwidth data for the bandwidth plan.

    np-5hh4a31emkt6u****

    ProcessInfos

    array<object>

    No

    A list of process monitoring metrics.

    object

    No

    A process monitoring metric.

    ProcessName

    string

    No

    The process name.

    php-fpm

    ProcessIds

    array

    No

    A list of process IDs.

    integer

    No

    The process ID.

    approval-process-c47080c1f238e889

    Period

    integer

    No

    The statistic period of the monitoring data.

    Valid values: 60, 900, and 3600.

    Unit: seconds.

    60

    StartTime

    string

    No

    The start time for the query.

    2019-01-31 10:00:00

    EndTime

    string

    No

    The end time for the query.

    2019-01-31 11:00:00

    NextToken

    string

    No

    A token that marks the position from which the query starts. Leave it empty to start from the beginning.

    AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****

    Length

    string

    No

    The number of entries to return on each page for a paged query.

    Default value: 1000. This means that 1000 monitoring data records are returned per page.

    1000

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned by the operation.

    RequestId

    string

    The request ID.

    425F351C-3F8E-5218-A520-B6311D0D****

    Count

    integer

    The number of records.

    1

    NextToken

    string

    The token for the next query. If not all results are returned, this parameter is not empty. Use the returned token to query the next page.

    AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****

    MetricTotalModel

    array<object>

    The instance monitoring data.

    array<object>

    The instance monitoring data.

    AndroidInstanceId

    string

    For instance-level monitoring, the Cloud Phone instance ID is returned.

    acp-fkuit0cmyru4p****

    MetricModelList

    array<object>

    The monitoring data for metrics.

    array<object>

    The monitoring data for the metric.

    MetricName

    string

    The name of the metric.

    cpu_utilization

    ProcessName

    string

    The process name.

    需要

    DataPoints

    array<object>

    A list of monitoring data points.

    object

    A monitoring data point.

    Timestamp

    integer

    The timestamp of the statistics. Unit: milliseconds.

    1548777660000

    Minimum

    number

    The minimum value. Unit: %.

    Note

    The unit is bps when the metric is `bandwidth_package_usage_out` or `bandwidth_package_usage_in`.

    93.1

    Average

    number

    The average value. Unit: %.

    Note

    The unit is bps when the metric is `bandwidth_package_usage_out` or `bandwidth_package_usage_in`.

    99.52

    Maximum

    number

    The maximum value. Unit: %.

    Note

    The unit is bps when the metric is `bandwidth_package_usage_out` or `bandwidth_package_usage_in`.

    100

    Value

    number

    The data value. Unit: %.

    Note

    The unit is bps when the metric is `bandwidth_package_usage_out` or `bandwidth_package_usage_in`.

    tf-testacc-oos-parameter

    GpuId

    string

    The GPU ID.

    cpn-1t1bxvp9az2pk****-gpu-0

    InstanceId

    string

    The instance ID.

    np-5hh4a31emkt6u****

    Examples

    Success response

    JSON format

    {
  "RequestId": "425F351C-3F8E-5218-A520-B6311D0D****",
  "Count": 1,
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****",
  "MetricTotalModel": [
    {
      "AndroidInstanceId": "acp-fkuit0cmyru4p****",
      "MetricModelList": [
        {
          "MetricName": "cpu_utilization",
          "ProcessName": "需要",
          "DataPoints": [
            {
              "Timestamp": 1548777660000,
              "Minimum": 93.1,
              "Average": 99.52,
              "Maximum": 100,
              "Value": 0,
              "GpuId": "cpn-1t1bxvp9az2pk****-gpu-0\n"
            }
          ]
        }
      ],
      "InstanceId": "np-5hh4a31emkt6u****\n"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.