Retrieve CPU, memory bus, I/O bus or CPU interconnect utilization data per entity.
HPE Compute Ops Management API (latest)
HPE Compute Operations Management provides a Restful API to customers who want to manage their devices programmatically or through a command line. The API enables customers to invoke operations or tasks such as list devices, see device details, device health, and manage their device's firmware.
UPDATED API ENDPOINTS
Compute Ops Management now supports the HPE GreenLake API endpoints (<region>.api.greenlake.hpe.com). The Guide contains more information about this change.
Download OpenAPI description
Overview
License
Languages
Servers
API endpoint for US West
https://us-west.api.greenlake.hpe.com/
API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/
API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/
Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/
Query
Start date for utilization data retrieval.
start-date=2025-01-15
start-date=2025-04-01T06:00:00Z
End date for utilization data retrieval.
end-date=2025-01-15
end-date=2025-04-01T06:00:00Z
URI of the resource for which utilization data is to be retrieved. This can be a server, filter or group URI.
resource-uri=/compute-ops-mgmt/v1beta1/filters/e7cef8e6-a3f6-4490-b669-136e3ca40617
resource-uri=/compute-ops-mgmt/v1/servers/875765-S01+1M512501AB
resource-uri=/compute-ops-mgmt/v1/groups/420372b6-af2e-464d-970d-e9339abfc74f
The metric type for which utilization data is to be retrieved.
Enum"CPU_UTILIZATION""MEMORY_BUS_UTILIZATION""IO_BUS_UTILIZATION"
When it is set to true, the response will have details of servers which do not have utilization data available.
Default false
Example: excluded-servers=true
Limit the resources operated on by tags or return only the subset of resources that match all the filter tags.
filter-tags=('Rack' eq 'Rack1')
filter-tags=(('Rack' eq 'Rack1') AND ('Row' eq 'Row1'))
The order in which to return the resources in the collection. Sort expression is a property name, followed by asc (ascending) or desc (descending).
Default "collected/average asc"
Examples: sort=name asc
sort=collected/high asc
sort=metadata/processorDetails/speedGHz desc
sort=metadata/totalMemorySizeGB desc
Limit the resources operated on by an endpoint or return only the subset of resources that match the filter.
NOTE: The filter query parameter must use URL encoding.
filter=entityDetails/model eq 'Proliant DL 360'
filter=entityDetails/generation eq 'GEN_10'
filter=entityDetails/processor eq 'AMD 8 core Gen 10'
filter=entityDetails/location eq 'Bangalore, KA, India'
Limit the properties of the resource returned in a successful response. When applied to write operations, select controls only the properties that are returned, not which properties are operated on. All properties are returned if the select parameter is omitted.
The value of the select query parameter is a comma separated list of properties to include in the response. Nested properties use / as a separator, e.g. select=interfaces/name selects the name property within an interfaces object.
For operations that return paginated collections, select operates on the resources in the collection. The pagination properties like count and items are always included even when select is specified.
Select only the id and name properties of the resource
Headers
Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.
In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.
- API endpoint for US Westhttps://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/utilization-by-entity
- API endpoint for EU Centralhttps://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/utilization-by-entity
- API endpoint for AP Northeasthttps://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/utilization-by-entity
- Mock serverhttps://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/utilization-by-entity
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X GET \
'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/utilization-by-entity?start-date=string&end-date=string&resource-uri=string&metric-type=CPU_UTILIZATION' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "count": 2, "offset": 0, "total": 2, "excluded": 0, "metricDetails": { "metricType": "CPU_UTILIZATION", "metricUnit": "Percentage" }, "items": [ { … } ] }