Performance Manager Query Perf Provider Summary

Performance Manager Query Perf Provider Summary

Retrieves the PerfProviderSummary data object that defines the capabilities of the specified managed object with respect to statistics, such as whether it supports current or summary statistics.

Required privileges: System.View

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/PerformanceManager/{moId}/QueryPerfProviderSummary
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 PerformanceManager/{moId}.

string
release
Required

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


Request Body
QueryPerfProviderSummaryRequestType of type(s) application/json
Required
"QueryPerfProviderSummaryRequestType Object"
entity
Required

Reference to a managed object that provides performance data. If the entity specified by managed object reference is not a performance provider, an "InvalidArgument" exception is thrown.

Authentication
This operation uses the following authentication methods.
Responses
200

A data object containing metadata about the entity as a performance provider, such as the type of metrics (real-time, summary, or both) it generates and the refreshRate.

Returns PerfProviderSummary of type(s) application/json
"PerfProviderSummary Object"
entity
Required

Reference to the performance provider, the managed object that provides real-time or historical metrics.

The managed objects include but are not limited to managed entities, such as host systems, virtual machines, and resource pools.

boolean
currentSupported
Required

True if this entity supports real-time (current) statistics; false if it does not.

If this property is true for an entity, a client application can set the PerfQuerySpec.intervalId of the PerfQuerySpec (passed to the PerformanceManager.QueryPerf operation) to the PerfProviderSummary.refreshRate to obtain the maximum information possible for the entity.

boolean
summarySupported
Required

True if this entity supports historical (aggregated) statistics; false if it does not.

When this property is true for an entity, a client application can set the PerfQuerySpec.intervalId of PerformanceManager.QueryPerf to one of the historical intervals to obtain historical statistics for this entity.

integer As int32 As int32
refreshRate
Optional

Number of seconds between the generation of each counter.

This value applies only to entities that support real-time (current) statistics.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/PerformanceManager/{moId}/QueryPerfProviderSummary