Package org.jclouds.rackspace.cloudloadbalancers.v1.features

Interface ReportApi

public interface ReportApi

Reporting for load balancers.

Method Summary

Modifier and Type	Method	Description
HistoricalUsage	getHistoricalUsage(Date startTime, Date endTime)	View all transfer activity, average number of connections, and number of virtual IPs associated with the load balancing service.
LoadBalancerStats	getLoadBalancerStats(int loadBalancerId)	Current usage represents all usage recorded within the preceding 24 hours.
Iterable<String>	listAlgorithms()	Get all of the possible algorthims usable by load balancers.
PagedIterable<LoadBalancer>	listBillableLoadBalancers(Date startTime, Date endTime)	List billable load balancers for the given date range.
IterableWithMarker<LoadBalancer>	listBillableLoadBalancers(PaginationOptions options)
PagedIterable<LoadBalancerUsage>	listCurrentLoadBalancerUsage(int loadBalancerId)	Current usage represents all usage recorded within the preceding 24 hours.
IterableWithMarker<LoadBalancerUsage>	listCurrentLoadBalancerUsage(PaginationOptions options)
PagedIterable<LoadBalancerUsage>	listLoadBalancerUsage(int loadBalancerId, Date startTime, Date endTime)	Historical usage data is available for up to 90 days of service activity.
IterableWithMarker<LoadBalancerUsage>	listLoadBalancerUsage(PaginationOptions options)
Iterable<Protocol>	listProtocols()	All load balancers must define the protocol of the service which is being load balanced.

Method Detail

listBillableLoadBalancers

@Named("report:list")
@GET
@Consumes("application/json")
@Path("/loadbalancers/billable")
PagedIterable<LoadBalancer> listBillableLoadBalancers(@QueryParam("startTime")
                                                      Date startTime,
                                                      @QueryParam("endTime")
                                                      Date endTime)

List billable load balancers for the given date range.

listBillableLoadBalancers

@Named("report:list")
@GET
@Consumes("application/json")
@Path("/loadbalancers/billable")
IterableWithMarker<LoadBalancer> listBillableLoadBalancers(PaginationOptions options)

getHistoricalUsage

@Named("report:list")
@GET
@Consumes("application/json")
@Path("/loadbalancers/usage")
HistoricalUsage getHistoricalUsage(@QueryParam("startTime")
                                   Date startTime,
                                   @QueryParam("endTime")
                                   Date endTime)

View all transfer activity, average number of connections, and number of virtual IPs associated with the load balancing service. Historical usage data is available for up to 90 days of service activity.

listLoadBalancerUsage

@Named("report:list")
@GET
@Consumes("application/json")
@Path("/loadbalancers/{id}/usage")
PagedIterable<LoadBalancerUsage> listLoadBalancerUsage(@PathParam("id")
                                                       int loadBalancerId,
                                                       @QueryParam("startTime")
                                                       Date startTime,
                                                       @QueryParam("endTime")
                                                       Date endTime)

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

listLoadBalancerUsage

@Named("report:list")
@GET
@Consumes("application/json")
@Path("/loadbalancers/{id}/usage")
IterableWithMarker<LoadBalancerUsage> listLoadBalancerUsage(PaginationOptions options)

listCurrentLoadBalancerUsage

@Named("report:list")
@GET
@Consumes("application/json")
@Path("/loadbalancers/{id}/usage/current")
PagedIterable<LoadBalancerUsage> listCurrentLoadBalancerUsage(@PathParam("id")
                                                              int loadBalancerId)

Current usage represents all usage recorded within the preceding 24 hours.

listCurrentLoadBalancerUsage

@Named("report:list")
@GET
@Consumes("application/json")
@Path("/loadbalancers/{id}/usage/current")
IterableWithMarker<LoadBalancerUsage> listCurrentLoadBalancerUsage(PaginationOptions options)

getLoadBalancerStats

@Named("report:list")
@GET
@Consumes("application/json")
@Path("/loadbalancers/{id}/stats")
LoadBalancerStats getLoadBalancerStats(@PathParam("id")
                                       int loadBalancerId)

Current usage represents all usage recorded within the preceding 24 hours.

listProtocols

@Named("report:list")
@GET
@Consumes("application/json")
@Path("/loadbalancers/protocols")
Iterable<Protocol> listProtocols()

All load balancers must define the protocol of the service which is being load balanced. The protocol selection should be based on the protocol of the back-end nodes. When configuring a load balancer, the default port for the given protocol will be selected from this list unless otherwise specified.

listAlgorithms

@Named("report:list")
@GET
@Consumes("application/json")
@Path("/loadbalancers/algorithms")
Iterable<String> listAlgorithms()

Get all of the possible algorthims usable by load balancers.