apache/cloudstack
1
0
Fork 0
mirror of https://github.com/apache/cloudstack.git synced 2025-12-19 03:54:03 +01:00
Code Issues Packages Projects Releases Wiki Activity
cloudstack/docs/tmp/en-US/html/usage-record-format.html

212 lines
16 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>5.1. Usage Record Format</title><link rel="stylesheet" type="text/css" href="Common_Content/css/default.css" /><link rel="stylesheet" media="print" href="Common_Content/css/print.css" type="text/css" /><meta name="generator" content="publican 2.8" /><meta name="package" content="Apache_CloudStack-API_Developers_Guide-4.0.0-incubating-en-US-1-" /><link rel="home" href="index.html" title="CloudStack API Developer's Guide" /><link rel="up" href="working-with-usage-data.html" title="Chapter 5. Working With Usage Data" /><link rel="prev" href="working-with-usage-data.html" title="Chapter 5. Working With Usage Data" /><link rel="next" href="usage-types.html" title="5.2. Usage Types" /></head><body><p id="title"><a class="left" href="http://cloudstack.org"><img src="Common_Content/images/image_left.png" alt="Product Site" /></a><a class="right" href="http://docs.cloudstack.org"><img src="Common_Content/images/image_right.png" alt="Documentation Site" /></a></p><ul class="docnav"><li class="previous"><a accesskey="p" href="working-with-usage-data.html"><strong>Prev</strong></a></li><li class="next"><a accesskey="n" href="usage-types.html"><strong>Next</strong></a></li></ul><div xml:lang="en-US" class="section" id="usage-record-format" lang="en-US"><div class="titlepage"><div><div><h2 class="title" id="usage-record-format">5.1. Usage Record Format</h2></div></div></div><div xml:lang="en-US" class="section" id="virtual-machine-usage-record-format" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="virtual-machine-usage-record-format">5.1.1. Virtual Machine Usage Record Format</h3></div></div></div><div class="para">
For running and allocated virtual machine usage, the following fields exist in a usage record:
</div><div class="itemizedlist"><ul><li class="listitem"><div class="para">
account – name of the account
</div></li><li class="listitem"><div class="para">
accountid – ID of the account
</div></li><li class="listitem"><div class="para">
domainid – ID of the domain in which this account resides
</div></li><li class="listitem"><div class="para">
zoneid – Zone where the usage occurred
</div></li><li class="listitem"><div class="para">
description – A string describing what the usage record is tracking
</div></li><li class="listitem"><div class="para">
usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for VM running time)
</div></li><li class="listitem"><div class="para">
usagetype – A number representing the usage type (see Usage Types)
</div></li><li class="listitem"><div class="para">
rawusage – A number representing the actual usage in hours
</div></li><li class="listitem"><div class="para">
virtualMachineId – The ID of the virtual machine
</div></li><li class="listitem"><div class="para">
name – The name of the virtual machine
</div></li><li class="listitem"><div class="para">
offeringid – The ID of the service offering
</div></li><li class="listitem"><div class="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.
</div></li><li class="listitem"><div class="para">
usageid – Virtual machine
</div></li><li class="listitem"><div class="para">
type – Hypervisor
</div></li><li class="listitem"><div class="para">
startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record
</div></li></ul></div></div><div xml:lang="en-US" class="section" id="network-usage-record-format" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="network-usage-record-format">5.1.2. Network Usage Record Format</h3></div></div></div><div class="para">
For network usage (bytes sent/received), the following fields exist in a usage record.
</div><div class="itemizedlist"><ul><li class="listitem"><div class="para">
account – name of the account
</div></li><li class="listitem"><div class="para">
accountid – ID of the account
</div></li><li class="listitem"><div class="para">
domainid – ID of the domain in which this account resides
</div></li><li class="listitem"><div class="para">
zoneid – Zone where the usage occurred
</div></li><li class="listitem"><div class="para">
description – A string describing what the usage record is tracking
</div></li><li class="listitem"><div class="para">
usagetype – A number representing the usage type (see Usage Types)
</div></li><li class="listitem"><div class="para">
rawusage – A number representing the actual usage in hours
</div></li><li class="listitem"><div class="para">
usageid – Device ID (virtual router ID or external device ID)
</div></li><li class="listitem"><div class="para">
type – Device type (domain router, external load balancer, etc.)
</div></li><li class="listitem"><div class="para">
startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record
</div></li></ul></div></div><div xml:lang="en-US" class="section" id="ipaddress-usage-record-format" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="ipaddress-usage-record-format">5.1.3. IP Address Usage Record Format</h3></div></div></div><div class="para">
For IP address usage the following fields exist in a usage record.
</div><div class="itemizedlist"><ul><li class="listitem"><div class="para">
account - name of the account
</div></li><li class="listitem"><div class="para">
accountid - ID of the account
</div></li><li class="listitem"><div class="para">
domainid - ID of the domain in which this account resides
</div></li><li class="listitem"><div class="para">
zoneid - Zone where the usage occurred
</div></li><li class="listitem"><div class="para">
description - A string describing what the usage record is tracking
</div></li><li class="listitem"><div class="para">
usage - String representation of the usage, including the units of usage
</div></li><li class="listitem"><div class="para">
usagetype - A number representing the usage type (see Usage Types)
</div></li><li class="listitem"><div class="para">
rawusage - A number representing the actual usage in hours
</div></li><li class="listitem"><div class="para">
usageid - IP address ID
</div></li><li class="listitem"><div class="para">
startdate, enddate - The range of time for which the usage is aggregated; see Dates in the Usage Record
</div></li><li class="listitem"><div class="para">
issourcenat - Whether source NAT is enabled for the IP address
</div></li><li class="listitem"><div class="para">
iselastic - True if the IP address is elastic.
</div></li></ul></div></div><div xml:lang="en-US" class="section" id="disk-volume-usage-record-format" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="disk-volume-usage-record-format">5.1.4. Disk Volume Usage Record Format</h3></div></div></div><div class="para">
For disk volumes, the following fields exist in a usage record.
</div><div class="itemizedlist"><ul><li class="listitem"><div class="para">
account – name of the account
</div></li><li class="listitem"><div class="para">
accountid – ID of the account
</div></li><li class="listitem"><div class="para">
domainid – ID of the domain in which this account resides
</div></li><li class="listitem"><div class="para">
zoneid – Zone where the usage occurred
</div></li><li class="listitem"><div class="para">
description – A string describing what the usage record is tracking
</div></li><li class="listitem"><div class="para">
usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for hours)
</div></li><li class="listitem"><div class="para">
usagetype – A number representing the usage type (see Usage Types)
</div></li><li class="listitem"><div class="para">
rawusage – A number representing the actual usage in hours
</div></li><li class="listitem"><div class="para">
usageid – The volume ID
</div></li><li class="listitem"><div class="para">
offeringid – The ID of the disk offering
</div></li><li class="listitem"><div class="para">
type – Hypervisor
</div></li><li class="listitem"><div class="para">
templateid – ROOT template ID
</div></li><li class="listitem"><div class="para">
size – The amount of storage allocated
</div></li><li class="listitem"><div class="para">
startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record
</div></li></ul></div></div><div xml:lang="en-US" class="section" id="template-iso-snapshot-usage-record-format" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="template-iso-snapshot-usage-record-format">5.1.5. Template, ISO, and Snapshot Usage Record Format</h3></div></div></div><div class="itemizedlist"><ul><li class="listitem"><div class="para">
account – name of the account
</div></li><li class="listitem"><div class="para">
accountid – ID of the account
</div></li><li class="listitem"><div class="para">
domainid – ID of the domain in which this account resides
</div></li><li class="listitem"><div class="para">
zoneid – Zone where the usage occurred
</div></li><li class="listitem"><div class="para">
description – A string describing what the usage record is tracking
</div></li><li class="listitem"><div class="para">
usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for hours)
</div></li><li class="listitem"><div class="para">
usagetype – A number representing the usage type (see Usage Types)
</div></li><li class="listitem"><div class="para">
rawusage – A number representing the actual usage in hours
</div></li><li class="listitem"><div class="para">
usageid – The ID of the the template, ISO, or snapshot
</div></li><li class="listitem"><div class="para">
offeringid – The ID of the disk offering
</div></li><li class="listitem"><div class="para">
templateid – – Included only for templates (usage type 7). Source template ID.
</div></li><li class="listitem"><div class="para">
size – Size of the template, ISO, or snapshot
</div></li><li class="listitem"><div class="para">
startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record
</div></li></ul></div></div><div xml:lang="en-US" class="section" id="loadbalancer-policy-port-forwarding-rule-usage-record-format" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="loadbalancer-policy-port-forwarding-rule-usage-record-format">5.1.6. Load Balancer Policy or Port Forwarding Rule Usage Record Format</h3></div></div></div><div class="itemizedlist"><ul><li class="listitem"><div class="para">
account - name of the account
</div></li><li class="listitem"><div class="para">
accountid - ID of the account
</div></li><li class="listitem"><div class="para">
domainid - ID of the domain in which this account resides
</div></li><li class="listitem"><div class="para">
zoneid - Zone where the usage occurred
</div></li><li class="listitem"><div class="para">
description - A string describing what the usage record is tracking
</div></li><li class="listitem"><div class="para">
usage - String representation of the usage, including the units of usage (e.g. 'Hrs' for hours)
</div></li><li class="listitem"><div class="para">
usagetype - A number representing the usage type (see Usage Types)
</div></li><li class="listitem"><div class="para">
rawusage - A number representing the actual usage in hours
</div></li><li class="listitem"><div class="para">
usageid - ID of the load balancer policy or port forwarding rule
</div></li><li class="listitem"><div class="para">
usagetype - A number representing the usage type (see Usage Types)
</div></li><li class="listitem"><div class="para">
startdate, enddate - The range of time for which the usage is aggregated; see Dates in the Usage Record
</div></li></ul></div></div><div xml:lang="en-US" class="section" id="network-offering-usage-record-format" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="network-offering-usage-record-format">5.1.7. Network Offering Usage Record Format</h3></div></div></div><div class="itemizedlist"><ul><li class="listitem"><div class="para">
account – name of the account
</div></li><li class="listitem"><div class="para">
accountid – ID of the account
</div></li><li class="listitem"><div class="para">
domainid – ID of the domain in which this account resides
</div></li><li class="listitem"><div class="para">
zoneid – Zone where the usage occurred
</div></li><li class="listitem"><div class="para">
description – A string describing what the usage record is tracking
</div></li><li class="listitem"><div class="para">
usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for hours)
</div></li><li class="listitem"><div class="para">
usagetype – A number representing the usage type (see Usage Types)
</div></li><li class="listitem"><div class="para">
rawusage – A number representing the actual usage in hours
</div></li><li class="listitem"><div class="para">
usageid – ID of the network offering
</div></li><li class="listitem"><div class="para">
usagetype – A number representing the usage type (see Usage Types)
</div></li><li class="listitem"><div class="para">
offeringid – Network offering ID
</div></li><li class="listitem"><div class="para">
virtualMachineId – The ID of the virtual machine
</div></li><li class="listitem"><div class="para">
virtualMachineId – The ID of the virtual machine
</div></li><li class="listitem"><div class="para">
startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record
</div></li></ul></div></div><div xml:lang="en-US" class="section" id="VPN-user-usage-record-format" lang="en-US"><div class="titlepage"><div><div><h3 class="title" id="VPN-user-usage-record-format">5.1.8. VPN User Usage Record Format</h3></div></div></div><div class="itemizedlist"><ul><li class="listitem"><div class="para">
account – name of the account
</div></li><li class="listitem"><div class="para">
accountid – ID of the account
</div></li><li class="listitem"><div class="para">
domainid – ID of the domain in which this account resides
</div></li><li class="listitem"><div class="para">
zoneid – Zone where the usage occurred
</div></li><li class="listitem"><div class="para">
description – A string describing what the usage record is tracking
</div></li><li class="listitem"><div class="para">
usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for hours)
</div></li><li class="listitem"><div class="para">
usagetype – A number representing the usage type (see Usage Types)
</div></li><li class="listitem"><div class="para">
rawusage – A number representing the actual usage in hours
</div></li><li class="listitem"><div class="para">
usageid – VPN user ID
</div></li><li class="listitem"><div class="para">
usagetype – A number representing the usage type (see Usage Types)
</div></li><li class="listitem"><div class="para">
startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record
</div></li></ul></div></div></div><ul class="docnav"><li class="previous"><a accesskey="p" href="working-with-usage-data.html"><strong>Prev</strong>Chapter 5. Working With Usage Data</a></li><li class="up"><a accesskey="u" href="#"><strong>Up</strong></a></li><li class="home"><a accesskey="h" href="index.html"><strong>Home</strong></a></li><li class="next"><a accesskey="n" href="usage-types.html"><strong>Next</strong>5.2. Usage Types</a></li></ul></body></html>
Reference in New Issue View Git Blame Copy Permalink