Resource Pool Get Runtime

Resource Pool Get Runtime

Runtime information about a resource pool.

The ResourcePoolResourceUsage information within ResourcePoolRuntimeInfo can be transiently stale. Use RefreshRuntime method to update the information. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.

Request
URI
GET
https://{api_host}/sdk/vim25/{release}/ResourcePool/{moId}/runtime
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case ResourcePool/{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

OK

Returns ResourcePoolRuntimeInfo of type(s) application/json
"ResourcePoolRuntimeInfo Object"
memory
Required

Runtime resource usage for memory.

Values are in bytes.

cpu
Required

Runtime resource usage for CPU.

Values are in Mhz.

overallStatus
Required

Deprecated as of vSphere API 6.5. Use ManagedEntity.overallStatus.

Overall health of the tree.

See header for description of various statuses and when they are set.

string
sharesScalable
Optional

The scaling behavior of the shares of a given resource pool.

See ResourceConfigSpecScaleSharesBehaviorEnum for possible values. The system will automatically compute this property based on the ResourceConfigSpec.scaleDescendantsShares setting on every ancestor resource pool. This property does not apply to virtual machines.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/ResourcePool/{moId}/runtime
                
Virtual Infrastructure Operations
POST
Resource Pool Create Resource Pool
POST
Resource Pool Create V App
POST
Resource Pool Create Child VM Task
POST
Resource Pool Destroy Task
POST
Resource Pool Destroy Children
POST
Resource Pool Import V App
POST
Resource Pool Move Into Resource Pool
POST
Resource Pool Query Resource Config Option
Deprecated
POST
Resource Pool Refresh Runtime
POST
Resource Pool Register Child VM Task
POST
Resource Pool Reload
POST
Resource Pool Rename Task
POST
Resource Pool Set Custom Value
POST
Resource Pool Update Child Resource Configuration
POST
Resource Pool Update Config
GET
Resource Pool Get Alarm Actions Enabled
GET
Resource Pool Get Available Field
GET
Resource Pool Get Child Configuration
GET
Resource Pool Get Config
GET
Resource Pool Get Config Issue
GET
Resource Pool Get Config Status
GET
Resource Pool Get Custom Value
GET
Resource Pool Get Declared Alarm State
GET
Resource Pool Get Disabled Method
GET
Resource Pool Get Effective Role
GET
Resource Pool Get Name
GET
Resource Pool Get Namespace
GET
Resource Pool Get Overall Status
GET
Resource Pool Get Owner
GET
Resource Pool Get Parent
GET
Resource Pool Get Permission
GET
Resource Pool Get Recent Task
GET
Resource Pool Get Resource Pool
GET
Resource Pool Get Runtime
GET
Resource Pool Get Summary
GET
Resource Pool Get Tag
GET
Resource Pool Get Triggered Alarm State
GET
Resource Pool Get Value
GET
Resource Pool Get Vm