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://{vcenter-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 8.0.2.0 APIs.


Request Body
QueryPerfProviderSummaryRequestType of type(s) application/json
Required
{
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
entity
Required

The ManagedObjectReference data object type is a special-purpose data object. Commonly referred to as simply a "reference", "MoRef", "MOR", or other variations of this theme, instances of managed object references contain data that identifies specific server-side managed objects. Managed object references are typically one of the return types from a method invocation.

Managed object references are client application references to server-side managed objects. The client application uses ManagedObjectReference objects when it invokes operations on a server. A ManagedObjectReference is guaranteed to be unique and persistent during an object's lifetime. The reference persists after an object has moved within the inventory, across sessions, and across server restarts. If you remove an object, for example, a virtual machine, from the inventory, and then put it back, the reference changes.

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
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "currentSupported": false,
    "summarySupported": false,
    "refreshRate": 0
}
entity
Required

The ManagedObjectReference data object type is a special-purpose data object. Commonly referred to as simply a "reference", "MoRef", "MOR", or other variations of this theme, instances of managed object references contain data that identifies specific server-side managed objects. Managed object references are typically one of the return types from a method invocation.

Managed object references are client application references to server-side managed objects. The client application uses ManagedObjectReference objects when it invokes operations on a server. A ManagedObjectReference is guaranteed to be unique and persistent during an object's lifetime. The reference persists after an object has moved within the inventory, across sessions, and across server restarts. If you remove an object, for example, a virtual machine, from the inventory, and then put it back, the reference changes.

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.