QueryAvailablePerfMetricRequestType

QueryAvailablePerfMetricRequestType
QueryAvailablePerfMetricRequestType

The parameters of QueryAvailablePerfMetric.

JSON Example
{
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "beginTime": "string",
    "endTime": "string",
    "intervalId": 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.

string As date-time As date-time
beginTime
Optional

Starting time (server time) for a period of time from which to return available metrics. If not specified, defaults to oldest available metric for the specified entity.

string As date-time As date-time
endTime
Optional

Ending time (server time) for a period of time from which to return available performance metrics. If not specified, defaults to the most recently generated metric for the specified entity.

integer As int32 As int32
intervalId
Optional

Period of time from which to retrieve metrics, defined by intervalId (rather than beginTime or endTime). Valid intervalIds include:

  • For real-time counters, the refreshRate of the performance provider.
  • For historical counters, the samplingPeriod of the historical interval.

If this parameter is not specified, the system returns available metrics for historical statistics.