VMware Cloud Director API - HistoricUsage

VMware Cloud Director API - HistoricUsage

HistoricUsageType

Element:
HistoricUsage
Type:
HistoricUsageType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
A collection of time-based metrics representing historic usage statistics
Since:
5.6
Schema:
metrics.xsd
Media type(s):
application/vnd.vmware.vcloud.metrics.historicUsage+json
application/vnd.vmware.vcloud.metrics.historicUsage+xml
Extends:
ResourceType
XML Representation:
<HistoricUsage xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <MetricSeries name="xs:string" unit="xs:string" expectedInterval="xs:int">
        <Sample timestamp="xs:dateTime" value="xs:decimal"/>
    </MetricSeries>
</HistoricUsage>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 5.6 The URI of the entity.
type string No always 5.6 The MIME type of the entity.

Elements

Element Type Required Modifiable Since Deprecated Description
Link LinkType No none 5.6 A reference to an entity or operation associated with this object.
MetricSeries TimeSeriesMetricType No 5.6
VCloudExtension VCloudExtensionType No always 5.6 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD Operation Description Since Deprecated
create POST /org/{id}/metrics/historic Retrieve the metrics for a given org based on the filters provided by the spec
create POST /vApp/{id}/metrics/historic Gets the historic usage for VM metrics according to the provided spec object.
create POST /vdc/{id}/metrics/historic Retrieves rolled up metrics for a VDC according to the spec
read GET /org/{id}/metrics/historic Retrieve the all the metrics for a given org for the past 24 hours
read GET /vApp/{id}/metrics/historic Gets the past 24 hours worth of samples for all available VM metrics.
read GET /vdc/{id}/metrics/historic Retrieves the past 24h rolled up metrics for a VDC