4.9.1. List Usage

Name	URI	Description
GET	/loadbalancers/billable?startTime=2010-12-15&endTime=2011-5-1 &offset=2&limit=2	List billable load balancers for the given date range. The response is paginated with a default limit of 500 and a maximum limit of 1000.
GET	/loadbalancers/usage?startTime=2010-12-15&endTime=2011-5-1	List account level usage.
GET	/loadbalancers/loadBalancerId/usage?startTime=2010-12-15&endTime=2011-5-1	List historical usage.
GET	/loadbalancers/loadBalancerId/usage/current	List current usage.

Normal Response Code(s): 200

Error Response Code(s): loadbalancerFault (400, 500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

This operation does not require a request body.

The load balancer usage reports provide a view of all transfer activity, average number of connections, and number of virtual IPs associated with the load balancing service. Current usage represents all usage recorded within the preceding 24 hours. Values for both incomingTransfer and outgoingTransfer are expressed in bytes transferred.

The optional startTime and endTime parameters can be used to filter all usage. If the startTime parameter is supplied but the endTime parameter is not, then all usage beginning with the startTime will be provided. Likewise, if the endTime parameter is supplied but the startTime parameter is not, then all usage will be returned up to the endTime specified.

	Note
	Historical usage data is available for up to 90 days of service activity.

Example 4.55. Report Billable Load Balancers Response (Paginated): XML

<loadBalancers
    xmlns="http://docs.openstack.org/loadbalancers/api/v1.0"
    xmlns:atom="http://www.w3.org/2005/Atom">
    <loadBalancer id="761" name="lb01" algorithm="RANDOM"
        protocol="HTTP" port="80" status="DELETED">
        <created time="2012-01-23T17:09:08-06:00"/>
        <updated time="2012-01-27T15:15:58-06:00"/>
    </loadBalancer>
    <loadBalancer id="762" name="lb02" algorithm="RANDOM"
        protocol="HTTP" port="80" status="DELETED">
        <created time="2012-01-23T17:10:30-06:00"/>
        <updated time="2012-01-27T15:26:47-06:00"/>
    </loadBalancer>
    <atom:link
        href="http://localhost:8080/lb-mgmt-rest-service/528830/loadbalancers/billable?startTime=2012-01-27&amp;endTime=2012-02-26&amp;offset=4&amp;limit=2"
        rel="next"/>
    <atom:link
        href="http://localhost:8080/lb-mgmt-rest-service/528830/loadbalancers/billable?startTime=2012-01-27&amp;endTime=2012-02-26&amp;offset=0&amp;limit=2"
        rel="previous"/>
</loadBalancers>

Example 4.56. Report Billable Load Balancers Response (Paginated): JSON

{
    "loadBalancers": [
        {
            "name": "lb01",
            "id": 761,
            "port": 80,
            "protocol": "HTTP",
            "algorithm": "RANDOM",
            "status": "DELETED",
            "created": {
                "time": "2012-01-23T17:09:08-06:00"
            },
            "updated": {
                "time": "2012-01-27T15:15:58-06:00"
            }
        },
        {
            "name": "lb02",
            "id": 762,
            "port": 80,
            "protocol": "HTTP",
            "algorithm": "RANDOM",
            "status": "DELETED",
            "created": {
                "time": "2012-01-23T17:10:30-06:00"
            },
            "updated": {
                "time": "2012-01-27T15:26:47-06:00"
            }
        }
    ],
    "links": [
        {
            "otherAttributes": {},
            "href": "http://localhost:8080/lb-mgmt-rest-service/528830/loadbalancers/billable?startTime=2012-01-27&endTime=2012-02-26&offset=4&limit=2",
            "rel": "next"
        },
        {
            "otherAttributes": {},
            "href": "http://localhost:8080/lb-mgmt-rest-service/528830/loadbalancers/billable?startTime=2012-01-27&endTime=2012-02-26&offset=0&limit=2",
            "rel": "previous"
        }
    ]
}

Example 4.57. Report Load Balancer Usage Response: XML

<loadBalancerUsage xmlns="http://docs.openstack.org/loadbalancers/api/v1.0">
    <loadBalancerUsageRecord
            id="394"
            averageNumConnections="0.0"
            incomingTransfer="0"
            outgoingTransfer="0"
            averageNumConnectionsSsl="0.0"
            incomingTransferSsl="0"
            outgoingTransferSsl="0"
            numVips="1"
            numPolls="32"
            startTime="2010-12-21T12:32:07-06:00"
            endTime="2010-12-21T16:23:54-06:00"
            vipType="PUBLIC"
            sslMode="OFF"
            eventType="CREATE_LOADBALANCER"/>
    <loadBalancerUsageRecord
            id="473"
            averageNumConnections="0.0"
            incomingTransfer="0"
            outgoingTransfer="0"
            averageNumConnectionsSsl="0.0"
            incomingTransferSsl="0"
            outgoingTransferSsl="0"
            numVips="2"
            numPolls="5"
            startTime="2010-12-21T12:32:07-06:00"
            endTime="2010-12-21T12:36:30-06:00"
            vipType="PUBLIC"
            sslMode="MIXED"
            eventType="SSL_MIXED_ON"/>
</loadBalancerUsage>

Example 4.58. Report Load Balancer Usage Response: JSON

{
    "loadBalancerUsageRecords": [
        {
            "id": 394,
            "averageNumConnections": 0.0,
            "incomingTransfer": 0,
            "outgoingTransfer": 0,
            "averageNumConnectionsSsl": 0.0,
            "incomingTransferSsl": 0,
            "outgoingTransferSsl": 0,
            "numVips": 1,
            "numPolls": 32,
            "startTime": "2010-12-21T12:32:07-06:00",
            "endTime": "2010-12-21T16:23:54-06:00" ,
            "vipType": "PUBLIC",
            "sslMode": "OFF",
            "eventType": "CREATE_LOADBALANCER"
        },
        {
            "id": 473,
            "averageNumConnections": 0.0,
            "incomingTransfer": 0,
            "outgoingTransfer": 0,
            "averageNumConnectionsSsl": 0.0,
            "incomingTransferSsl": 0,
            "outgoingTransferSsl": 0,
            "numVips": 2,
            "numPolls": 5,
            "startTime": "2010-12-21T12:32:07-06:00",
            "endTime": "2010-12-21T12:36:30-06:00" ,
            "vipType": "PUBLIC",
            "sslMode": "MIXED",
            "eventType": "SSL_MIXED_ON"
        }
    ]
}

Legal notices