HP CloudSystem Matrix/Matrix Operating Environment 7.2 Integration Interfaces API and CLI Operations Reference Guide

11 Operations
Operations
The supported operations are specified in the following sections.
Summary Usage Report
getServiceUsagePage
Returns usage and cost data for selected services.
Report result is paged according to the information passed in.
getServiceUsagePageName
Specifies the period of time for which to return data, and specifies how
data should be consolidated in the report. There are two options for
Period periodParameters
formatting report result which depend on Period specification. If
PeriodType is set to DAILY, report will return one entry per pay per service
in the selected period. Each entry will contain usage information for that
service in that day. If PeriodType is set to PERIOD, result will contain one
entry per service for the entire period.
Specifies paging information for the data being returned. This attribute
identifies page size in terms of services and the page to be returned.
Paging
pagingInformation
Query is re-executed every time the API is called and the query result is
not stored in server. Attribute totalPages is ignored.
Controls which services are included in the result. If no filter is supplied,
all services for the given period are returned.
List<ServiceFilter>
serviceFilters
Required page for the specified query. This contains usage data for
services that match filters and existed over the specified period. Page is
formatted according to PeriodType attribute.
ServiceUsagePage
resultReport
Returns
InvalidPeriodExceptionExceptions
InvalidPagingException
InvalidFilterException
ChargebackException
RequiredParameterException
Detailed Usage Report
getServiceUsageDetailedPage
Returns detailed usage and cost data for selected services.getServiceUsageDetailPageName
Specifies the period of time for which to return data, and specifies how
data should be consolidated in the report. There are two options for
Period periodParameters
formatting report result which depend on Period specification. If
PeriodType is set to DAILY, report will return one entry per pay per service
in the selected period. Each entry will contain usage information for that
service in that day. If PeriodType is set to PERIOD, the result will contain
one entry per service for the entire period.
Specifies paging information for the data being returned. This attribute
identifies page size in terms of services and the page to be returned.
Attribute totalPages is ignored.
Paging pageInformation
Controls which services are included in the result. If no filter is supplied,
the call returns information on all services the logged user has access to.
List<ServiceFilter>
serviceFilters
Access to service data follows the same authorization model as elsewhere
in infrastructure orchestration (for example, the listServices API).
100 Operations