Alert Policy:List Alert Policies

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

List Alert Policies

GET /vdc/alertpolicy/list

Returns list of policies matching given parameters

Query Parameters

token	reference to last policy returned.
limit	number of policies requested in current fetch.
enabled	if set to true, only enabled policies are listed or if set to false, only disabled policies are listed. if null, all the policies are listed

Required Roles

This call has no restrictions.

Response Body

Field	Description	Type	Notes
alert_policies
alert_policy			0-* Elements
policyName		String
metricType		String
metricName		String
createdBy		String
isEnabled		String
isPerInstanceMetric	Defaults to false (i.e. metric value is inspected at VDC level). Set to true if the metric needs to be inspected at each node within the VDC.	String
period	Indicates the length of time to evaluate the metric to create each individual data point for a metric. If you choose one hour as the period, there is one data point every hour	Integer
periodUnits		String
datapointsToConsider	Indicates the number of the most recent data points to consider to trigger alert	Integer
datapointsToAlert	Indicates the number of data points that must be breaching to trigger an alert	Integer
statistic		String	Valid Values: MIN, MAX, AVG, SUM, COUNT
operator		String	Valid Values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL_TO
condition			0-* Elements
thresholdUnits		String
thresholdValue		String
severityType			Valid Values: WARNING, ERROR, CRITICAL
MaxPolicies		Integer
NextMarker		String
Filter		String
NextPageLink		String

Examples

Request

GET https://192.168.0.0:4443/vdc/alertpolicy/list HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

Response

HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alert_policies>
  <alert_policy>
    <policyName>BtreeChunkLevelGC</policyName>
    <metricType>Garbage Collection Statistics</metricType>
    <metricName>Btree Chunk Level GC</metricName>
    <createdBy>SYSTEM</createdBy>
    <isEnabled>true</isEnabled>
    <isPerInstanceMetric>false</isPerInstanceMetric>
    <period>24</period>
    <periodUnits>HOURS</periodUnits>
    <datapointsToConsider>7</datapointsToConsider>
    <datapointsToAlert>7</datapointsToAlert>
    <statistic>COUNT</statistic>
    <operator>GREATER_THAN</operator>
    <condition>
      <thresholdUnits>GB</thresholdUnits>
      <thresholdValue>100</thresholdValue>
      <severityType>WARNING</severityType>
    </condition>
  </alert_policy>
  <alert_policy>
    <policyName>RepoPartialGC</policyName>
    <metricType>Garbage Collection Statistics</metricType>
    <metricName>Repo Partial GC</metricName>
    <createdBy>SYSTEM</createdBy>
    <isEnabled>true</isEnabled>
    <isPerInstanceMetric>false</isPerInstanceMetric>
    <period>24</period>
    <periodUnits>HOURS</periodUnits>
    <datapointsToConsider>7</datapointsToConsider>
    <datapointsToAlert>7</datapointsToAlert>
    <statistic>COUNT</statistic>
    <operator>GREATER_THAN</operator>
    <condition>
      <thresholdUnits>GB</thresholdUnits>
      <thresholdValue>100</thresholdValue>
      <severityType>WARNING</severityType>
    </condition>
  </alert_policy>
  <alert_policy>
    <policyName>GCStatus</policyName>
    <metricType>Garbage Collection Statistics</metricType>
    <metricName>GC Status</metricName>
    <createdBy>SYSTEM</createdBy>
    <isEnabled>true</isEnabled>
    <isPerInstanceMetric>false</isPerInstanceMetric>
    <period>24</period>
    <periodUnits>HOURS</periodUnits>
    <datapointsToConsider>1</datapointsToConsider>
    <datapointsToAlert>1</datapointsToAlert>
    <statistic>COUNT</statistic>
    <operator>EQUAL_TO</operator>
    <condition>
      <thresholdValue>1</thresholdValue>
      <severityType>WARNING</severityType>
    </condition>
  </alert_policy>
  <MaxPolicies>100</MaxPolicies>
  <NextMarker/>
</alert_policies>

Request

GET https://192.168.0.0:4443/vdc/alertpolicy/list HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "alert_policies": {
    "alert_policy": [
      {
        "policyName": "BtreeChunkLevelGC",
        "metricType": "Garbage Collection Statistics",
        "metricName": "Btree Chunk Level GC",
        "createdBy": "SYSTEM",
        "isEnabled": "true",
        "isPerInstanceMetric": "false",
        "period": "24",
        "periodUnits": "HOURS",
        "datapointsToConsider": "7",
        "datapointsToAlert": "7",
        "statistic": "COUNT",
        "operator": "GREATER_THAN",
        "condition": {
          "thresholdUnits": "GB",
          "thresholdValue": "100",
          "severityType": "WARNING"
        }
      },
      {
        "policyName": "RepoPartialGC",
        "metricType": "Garbage Collection Statistics",
        "metricName": "Repo Partial GC",
        "createdBy": "SYSTEM",
        "isEnabled": "true",
        "isPerInstanceMetric": "false",
        "period": "24",
        "periodUnits": "HOURS",
        "datapointsToConsider": "7",
        "datapointsToAlert": "7",
        "statistic": "COUNT",
        "operator": "GREATER_THAN",
        "condition": {
          "thresholdUnits": "GB",
          "thresholdValue": "100",
          "severityType": "WARNING"
        }
      },
      {
        "policyName": "GCStatus",
        "metricType": "Garbage Collection Statistics",
        "metricName": "GC Status",
        "createdBy": "SYSTEM",
        "isEnabled": "true",
        "isPerInstanceMetric": "false",
        "period": "24",
        "periodUnits": "HOURS",
        "datapointsToConsider": "1",
        "datapointsToAlert": "1",
        "statistic": "COUNT",
        "operator": "EQUAL_TO",
        "condition": {
          "thresholdValue": "1",
          "severityType": "WARNING"
        }
      }
    ],
    "MaxPolicies": "100"
  }
}