VMware Cloud Director API - HistoricUsageSpec

VMware Cloud Director API - HistoricUsageSpec

HistoricUsageSpecType

Element:
HistoricUsageSpec
Type:
HistoricUsageSpecType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Specifies which historic usage metrics to retrieve
Since:
5.6
Schema:
metrics.xsd
Media type(s):
application/vnd.vmware.vcloud.metrics.historicUsageSpec+json
application/vnd.vmware.vcloud.metrics.historicUsageSpec+xml
Extends:
anyType
XML Representation:
<HistoricUsageSpec xmlns="http://www.vmware.com/vcloud/v1.5">
    <AbsoluteStartTime time="xs:dateTime"/>
    <RelativeStartTime interval="xs:short" unit="TimeUnitType"/>
    <AbsoluteEndTime time="xs:dateTime"/>
    <RelativeEndTime interval="xs:short" unit="TimeUnitType"/>
    <MetricPattern> xs:string </MetricPattern>
</HistoricUsageSpec>

Elements

Element Type Required Modifiable Since Deprecated Description
AbsoluteEndTime AbsoluteTimeType Yes 5.6
AbsoluteStartTime AbsoluteTimeType Yes 5.6
MetricPattern string No 5.6 A metric name pattern. Asterisk matches any character or group of characters in a metric name.
RelativeEndTime RelativeTimeType Yes 5.6
RelativeStartTime RelativeTimeType Yes 5.6

Operations

CRUD Operation Description Since Deprecated
as input POST /org/{id}/metrics/historic Retrieve the metrics for a given org based on the filters provided by the spec
as input POST /vApp/{id}/metrics/historic Gets the historic usage for VM metrics according to the provided spec object.
as input POST /vdc/{id}/metrics/historic Retrieves rolled up metrics for a VDC according to the spec