PerfQuerySpec

This data object specifies the query parameters, including the managed object reference to the target entity for statistics retrieval.

If the optional intervalId is omitted, the metrics are returned in their originally sampled interval.
- When an intervalId is specified, the server tries to summarize the information for the specified intervalId. However, if that interval does not exist or has no data, the server summarizes the information using the best interval available.
If the range between startTime and endTime crosses multiple sample interval periods, the result contains data from the longest interval in the period.

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_typeName": "string",
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "startTime": "string",
    "endTime": "string",
    "maxSample": 0,
    "metricId": [
        {
            "_typeName": "string",
            "counterId": 0,
            "instance": "string"
        }
    ],
    "intervalId": 0,
    "format": "string"
}

ManagedObjectReference

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

startTime

Optional

The server time from which to obtain counters.

If not specified, defaults to the first available counter. When a startTime is specified, the returned samples do not include the sample at startTime.

string As date-time As date-time

endTime

Optional

The time up to which statistics are retrieved.

Corresponds to server time. When endTime is omitted, the returned result includes up to the most recent metric value. When an endTime is specified, the returned samples include the sample at endTime.

integer As int32 As int32

maxSample

Optional

Limits the number of samples returned.

Defaults to the most recent sample (or samples), unless a time range is specified. Use this property only in conjunction with the intervalId to obtain real-time statistics (set the intervalId to the refreshRate. This property is ignored for historical statistics, and is not valid for the QueryPerfComposite operation.

array of PerfMetricId

metricId

Optional

The performance metrics to be retrieved.

This property is required for the QueryPerfComposite operation.

integer As int32 As int32

intervalId

Optional

The interval (samplingPeriod), in seconds, for the performance statistics. For aggregated information, use one of the historical intervals for this property.

See PerfInterval for more information.

To obtain the greatest detail, use the provider’s refreshRate for this property.

string

format

Optional

The format to be used while returning the statistics.