REST API Reference

Back Next

Getting custom IPU alert configurations

Use a GET request to get the custom IPU alert thresholds that you configured for organizations or tags.

GET request

To get the custom IPU alert configurations for your organization, use the following URl:

/public/core/v3/metering/ipuAlert/org('<organization Id>')

To get the custom IPU alert configurations for your tags, use the following URl:

/public/core/v3/metering/ipuAlert/org('organization Id')/viewTagsPreference

GET response

The response includes the following fields for organization configurations:

Field	Type	Description
orgName	String	Name of the organizaiton.
orgId	String	ID of the organization.
parentOrgId	String	ID of the parent organization. This field only applies to sub-organizations. Otherwise, it's NULL.
thresholdValue	Integer	Threshold value configured.
ipuConsumed	BigDecimal	Specifies how many IPUs are consumed. This field's value relates to the ipuThresholdPrefType field and displays either an absolute value or a percentage.
ipuThresholdPrefType	String	Type of threshold. Returns one of the following values: ABSOLUTE. PERCENTAGE.

The response includes the following fields for tag configurations:

Field	Type	Description
orgId	String	ID of the organization.
projectName	String	Name of the project.
folderName	String	Name of the folder. For project based thresholds, the folder name is NULL.
thresholdValue	Integer	Threshold value.
currentConsumption	BigDecimal	Specifies how many IPUs are consumed. This field's value relates to the ipuThresholdPrefType field and displays either an absolute value or a percentage.
ipuThresholdPrefType	String	Type of threshold. Returns one of the following values: ABSOLUTE. PERCENTAGE.

Get response example

If succesful, you might receive a response similar to the following for organization configurations:

 {
    "orgName": "Infa",
    "orgId": "3nqii4jGTiLda0M3ympy4E",
    "parentOrgId": null,
    "thresholdValue": 35,
    "ipuConsumed": 100,
    "ipuThresholdPrefType": "ABSOLUTE"
  }

A succesful response for tag configurations would look like the following:

 {
    "orgId": "3nqii4jGTiLda0M3ympy4E",
    "projectName": "My Project",
    "folderName": "Mapping Jobs",
    "thresholdValue": 20,
    "currentConsumption": 10,
    "ipuThresholdPrefType": "PERCENTAGE"
  }

Metering data

Download Guide

Watch

Comments

Cloud Data Integration Homepage