Cluster Compute Resource Get Resource Usage

Cluster Compute Resource Get Resource Usage

This API can be invoked to get the current CPU, memory and storage usage in the cluster.

Required privileges: System.Read

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/ClusterComputeResource/{moId}/GetResourceUsage
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case ClusterComputeResource/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Authentication
This operation uses the following authentication methods.
Responses
200

An instance of ResourceUsageSummary with following information:

  1. cpuCapacityMHz: Sum of CPU capacity of all the available hosts in the cluster in MHz.
  2. cpuUsedMHz: Sum of CPU consumed in all the available hosts in the cluster in MHz.
  3. memCapacityMB: Sum of memory capacity of all the available hosts in the cluster in MB.
  4. memUsedMB: Sum of memory consumed in all the available hosts in this cluster in MB.
  5. storageCapacityMB: Total storage capacity of all the accessible datastores in this cluster.
  6. storageUsedMB: Total storage consumed in all the accessible datastores in this cluster.
Returns ClusterResourceUsageSummary of type(s) application/json 
"ClusterResourceUsageSummary Object"
integer As int32 As int32
cpuUsedMHz
Required

cpuUsedMHz

integer As int32 As int32
cpuCapacityMHz
Required

cpuCapacityMHz

integer As int32 As int32
memUsedMB
Required

memUsedMB

integer As int32 As int32
memCapacityMB
Required

memCapacityMB

integer As int64 As int64
pMemAvailableMB
Optional

Deprecated as of vSphere 9.0 APIs with no replacement.

Do not use.

integer As int64 As int64
pMemCapacityMB
Optional

Deprecated as of vSphere 9.0 APIs with no replacement.

Do not use.

integer As int64 As int64
storageUsedMB
Required

storageUsedMB

integer As int64 As int64
storageCapacityMB
Required

storageCapacityMB


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/ClusterComputeResource/{moId}/GetResourceUsage
On This Page
Virtual Infrastructure Operations
POST
Cluster Compute Resource Abandon Hci Workflow
POST
Cluster Compute Resource Add Host Task
POST
Cluster Compute Resource Apply Recommendation
POST
Cluster Compute Resource Cancel Recommendation
POST
Cluster Compute Resource Configure HCI Task
POST
Cluster Compute Resource Destroy Task
POST
Cluster Compute Resource Disable Network Boot Task
POST
Cluster Compute Resource Enable Network Boot Task
POST
Cluster Compute Resource Cluster Enter Maintenance Mode
POST
Cluster Compute Resource Evc Manager
POST
Cluster Compute Resource Extend HCI Task
POST
Cluster Compute Resource Find Rules For Vm
POST
Cluster Compute Resource Get Resource Usage
POST
Cluster Compute Resource Get System V Ms Restricted Datastores
Deprecated
POST
Cluster Compute Resource Move Host Into Task
POST
Cluster Compute Resource Move Into Task
POST
Cluster Compute Resource Place Vm
POST
Cluster Compute Resource Recommend Hosts For Vm
Deprecated
POST
Cluster Compute Resource Reconfigure Cluster Task
Deprecated
POST
Cluster Compute Resource Reconfigure Compute Resource Task
POST
Cluster Compute Resource Refresh Recommendation
POST
Cluster Compute Resource Reload
POST
Cluster Compute Resource Rename Task
POST
Cluster Compute Resource Retrieve Das Advanced Runtime Info
POST
Cluster Compute Resource Set Crypto Mode
POST
Cluster Compute Resource Set Custom Value
POST
Cluster Compute Resource Stamp All Rules With Uuid Task
POST
Cluster Compute Resource Validate HCI Configuration
GET
Cluster Compute Resource Get Action History
GET
Cluster Compute Resource Get Alarm Actions Enabled
GET
Cluster Compute Resource Get Available Field
GET
Cluster Compute Resource Get Config Issue
GET
Cluster Compute Resource Get Config Manager Enabled
GET
Cluster Compute Resource Get Config Status
GET
Cluster Compute Resource Get Configuration
Deprecated
GET
Cluster Compute Resource Get Configuration Ex
GET
Cluster Compute Resource Get Custom Value
GET
Cluster Compute Resource Get Datastore
GET
Cluster Compute Resource Get Declared Alarm State
GET
Cluster Compute Resource Get Disabled Method
GET
Cluster Compute Resource Get Drs Fault
GET
Cluster Compute Resource Get Drs Recommendation
Deprecated
GET
Cluster Compute Resource Get Effective Role
GET
Cluster Compute Resource Get Environment Browser
GET
Cluster Compute Resource Get Hci Config
GET
Cluster Compute Resource Get Host
GET
Cluster Compute Resource Get Lifecycle Managed
GET
Cluster Compute Resource Get Migration History
GET
Cluster Compute Resource Get Name
GET
Cluster Compute Resource Get Network
GET
Cluster Compute Resource Get Network Boot Mode
GET
Cluster Compute Resource Get Overall Status
GET
Cluster Compute Resource Get Parent
GET
Cluster Compute Resource Get Permission
GET
Cluster Compute Resource Get Recent Task
GET
Cluster Compute Resource Get Recommendation
GET
Cluster Compute Resource Get Resource Pool
GET
Cluster Compute Resource Get Summary
GET
Cluster Compute Resource Get Summary Ex
Deprecated
GET
Cluster Compute Resource Get Tag
GET
Cluster Compute Resource Get Triggered Alarm State
GET
Cluster Compute Resource Get Value