Developer Documentation

TimeSeriesSpec

This structure is sent in a request for TimeSeries data and is used to specify what object stats should be returned for.


Properties

Required Property Name Type Description
optional cluster string

Cluster identifier for queries for a cluster. This field is optional and it is only relevant when the value of TimeSeries.Spec.obj-type is CLUSTER. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.

required end integer

UNIX timestamp value indicating when the requested series of statistical samples should end. https://en.wikipedia.org/wiki/Unix_time

optional namespace string

Namespace name for queries for a namespace. This field is optional and it is only relevant when the value of TimeSeries.Spec.obj-type is NAMESPACE. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

required obj_type SpecObjType Enum

Type of statistics object that the request is operating on.

optional pod TimeSeriesPodIdentifier

Pod Identifier for queries on an individual pod. This field is optional and it is only relevant when the value of TimeSeries.Spec.obj-type is POD.

required start integer

UNIX timestamp value indicating when the requested series of statistical samples should begin. https://en.wikipedia.org/wiki/Unix_time

Parameter To


Get Stats Time Series
Feedback

Was this page helpful?