Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Monitoring Query & Overview
GETMonitoringSince 1.0SynchronousAuth Required

GetTopResources

List the top-consuming resources for a given product type

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • productTypeStringRequired

    Product type to query (e.g. vm, host, storage)

Query Parameters

  • platformUuidString

    UUID of the target platform UUID of the target platform

  • limitInteger

    Maximum number of top resources to return Maximum number of top resources to return

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • uuidString

      Unique identifier of the resource

      Example: vm-xyz-001

    • nameString

      Display name of the resource

      Example: web-server-01

    • resourceTypeString

      Type of the resource (e.g. vm, host, volume)

      Example: vm

    • metricNameString

      Metric name used for ranking

      Example: cpu_usage_percent

    • valueLong

      Metric value for this resource

      Example: 87.3

    • unitString

      Unit of the metric value

      Example: %

Endpoint

GET/api/v1/monitoring/products/{productType}/top-resources

/api/v1/monitoring/products/{productType}/top-resources

Operation ID

GetTopResources

Permalink

Request Example

curl -X GET '{host}/api/v1/monitoring/products/{productType}/top-resources' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history