Retrieve utilization data by entity

get/compute-ops-mgmt/v1beta1/utilization-by-entity

Retrieve CPU, memory bus, I/O bus or CPU interconnect utilization data per entity.

SecurityBearer
Request
query Parameters
start-date
required
string <date>

Start date for utilization data retrieval.

Example: start-date=2025-01-01
end-date
required
string <date>

End date for utilization data retrieval.

Example: end-date=2025-04-01
excluded-servers
boolean
Default: false

When it is set to true, the response will have details of servers which do not have utilization data available.

Example: excluded-servers=true
resource-uri
required
string

URI of the resource for which utilization data is to be retrieved. This can be a server URI or a filter URI.

Examples:
resource-uri=/compute-ops-mgmt/v1/servers/875765-S01+1M512501AB
resource-uri=/compute-ops-mgmt/v1beta1/filters/e7cef8e6-a3f6-4490-b669-136e3ca40617
metric-type
required
string

The metric type for which utilization data is to be retrieved.

Enum: "CPU_UTILIZATION" "MEMORY_BUS_UTILIZATION" "IO_BUS_UTILIZATION" "CPU_INTERCONNECT_UTILIZATION"
sort
string
Default: "collected/average asc"

The order in which to return the resources in the collection. Sort expression is a property name, followed by asc (ascending) or desc (descending).

Examples:
sort=name asc
sort=collected/high asc
sort=metadata/processorDetails/speedGHz desc
sort=metadata/totalMemorySizeGB desc
offset
integer >= 0
Default: 0

Zero-based resource offset to start the response from

Example: offset=10
limit
integer [ 1 .. 100 ]
Default: 10

The maximum number of records to return.

Example: limit=10
Responses
200

OK

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

Request samples 
Response samples 
application/json
{
  • "count": 2,
  • "offset": 0,
  • "total": 2,
  • "excluded": 0,
  • "metricDetails": {
    },
  • "items": [
    ]
}