en-US/virtual-machine-usage-record-format.xml

<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>

<!-- Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership.  The ASF licenses this file
 to you under the Apache License, Version 2.0 (the
 "License"); you may not use this file except in compliance
 with the License.  You may obtain a copy of the License at
 
   http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing,
 software distributed under the License is distributed on an
 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
-->

<section id="virtual-machine-usage-record-format">
    <title>Virtual Machine Usage Record Format</title>
    <para>For running and allocated virtual machine usage, the following fields exist in a usage record:</para>
    <itemizedlist>
        <listitem><para>account – name of the account</para></listitem>
        <listitem><para>accountid – ID of the account</para></listitem>
        <listitem><para>domainid – ID of the domain in which this account resides</para></listitem>
        <listitem><para>zoneid – Zone where the usage occurred</para></listitem>
        <listitem><para>description – A string describing what the usage record is tracking</para></listitem>
        <listitem><para>usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for VM running time)</para></listitem>
        <listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
        <listitem><para>rawusage – A number representing the actual usage in hours</para></listitem>
        <listitem><para>virtualMachineId – The ID of the virtual machine</para></listitem>
        <listitem><para>name – The name of the virtual machine</para></listitem>
        <listitem><para>offeringid – The ID of the service offering</para></listitem>
        <listitem><para>templateid – The ID of the template or the ID of the parent template. The parent template value is present when the current template was created from a volume.</para></listitem>
        <listitem><para>usageid – Virtual machine</para></listitem>
        <listitem><para>type – Hypervisor</para></listitem>
        <listitem><para>startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
    </itemizedlist>
</section>