VsanPerfQuerySpec

VsanPerfQuerySpec
VsanPerfQuerySpec

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

For supported entity types, metric groups, metrics:
See VsanPerfQueryPerf

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "entityRefId": "string",
    "startTime": "string",
    "endTime": "string",
    "group": "string",
    "labels": [
        "string"
    ],
    "interval": 0
}
string
entityRefId
Required

The 'entityRefId' is an entity reference id, which is used to identify the target entity (i.e.

clusters, hosts) you want to query. Here an entity reference id consists of an entity type and an UUID of the entity. Its format is <entity-type>:<entity-uuid>. It is possible to pass '*' as the value for entity-uuid in case one wants to query all entities of a certain type. For supported entity types:
See VsanPerfQueryPerf

string As date-time As date-time
startTime
Optional

The startTime is the server time from which to obtain counters.

This field must be specified, and the returned samples do not include the sample at startTime.

string As date-time As date-time
endTime
Optional

The endTime is the server time up to which statistics are retrieved.

This field will be replaced by current server time if it is later than current server time. This field must be specified and the returned samples include the sample at endTime.

string
group
Optional

A type of entity (like hosts) may have metrics with same names (i.e.

IOPS, Throughput) in different groups/view-points (i.e. DOMClient, DOMCompMgr). Here the 'group' attribute is used to identify which group of metrics is to be queried for an entity. If group is not set, a default group will be used. For supported entity types, metric groups, metrics:
See VsanPerfQueryPerf

array of string
labels
Optional

The performance metrics (labels) to be retrieved.

The label is also used in VsanPerfMetricId of returned metrics data.

integer As int32 As int32
interval
Optional

The interval, in seconds, for aggregated performance statistics.

Please ignore this field. It is not used in this version.

Property Of