Cloud Cruiser became HPE Consumption Analytics on Nov. 1, 2018. You'll still see the old name in places while we update this site.

 

 

Consumption Analytics Documentation

Home > Documentation for older versions > Cloud Cruiser 3 > REST API reference > Budgets and alerts > Get alerts for a customer

Get alerts for a customer

Retrieves all alerts generated for a specified customer during a specified accounting period or year.

Resource URL

POST http://<ccServerURL>/rest/v1/budgets/alerts

Request

Parameters

None

Content-Type

application/xml

Body

A query for alerts, as XML text with the root element alertQueryInput or JAXB type com.cloudcruiser.server.webservices.v1.dto.budgets.AlertQueryInput.

Response

Content-Type

application/xml

Body

The requested alerts, as XML text with the root element alertInstances or JAXB type com.cloudcruiser.server.webservices.v1.dto.budgets.AlertInstances.

Example

URL invocation

POST http://localhost:8080/rest/v1/budgets/alerts

Java invocation

AlertInstances alerts = budgetsServiceProxy.getAlerts(alertQueryInput);​

Request body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alertQueryInput xmlns="http://www.cloudcruiser.com/webservices/v1/Budget">
  <customer accountId="B"/>
  <accountingYear>2013</accountingYear>
</alertQueryInput>
Response body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alertInstances xmlns="http://www.cloudcruiser.com/webservices/v1/Budget" count="1">
  <alertInstance id="10001" budgetType="COST" valueType="COST">
    <customer id="8" accountId="B" accountingDay="5"/>
    <currencyCode>usd</currencyCode>
    <description>Generated Cost Alert</description>
    <thresholdPercent>100</thresholdPercent>
    <accountingYear>2013</accountingYear>
    <accountingPeriod>11</accountingPeriod>
    <accountingStartDate year="2013" month="11" day="5"/>
    <accountingEndDate year="2013" month="12" day="4"/>
    <periodBudgetValue>42500.0</periodBudgetValue>
    <actualUsage>45342.61</actualUsage>
    <dailyUsage>15114.2</dailyUsage>
    <projectedUsage>453426.0</projectedUsage>
    <projectedOverage>410926.0</projectedOverage>
    <isProjected>false</isProjected>
    <sendDate year="2013" month="11" day="8"/>
    <sendTo>
      <address>admin@bigorg.com</address>
      <address>bob@b.com</address>
      <address>bart@b.com</address>
    </sendTo>
  </alertInstance>
</alertInstances>
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.