Microsoft Azure Metrics Advisor REST API

Microsoft Azure Metrics Advisor REST API

List all anomaly alerting configurations for specific anomaly detection configuration

List all anomaly alerting configurations for specific anomaly detection configuration

Select the testing console in the region where you created your resource:

Open API testing console

Request URL

Request parameters

string

Format - uuid. anomaly detection configuration unique id

(optional)
integer

Format - int32. for paging, skipped number

(optional)
integer

Format - int32. the maximum number of items in one page

Request headers

string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Response 200

Success

{
  "value": [
    {
      "name": "alerting configuration name",
      "crossMetricsOperator": "AND",
      "hookIds": [
        "00000000-0000-0000-0000-000000000001"
      ],
      "metricAlertingConfigurations": [
        {
          "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
          "anomalyScopeType": "All",
          "negationOperation": false,
          "severityFilter": {
            "minAlertSeverity": "Medium",
            "maxAlertSeverity": "High"
          },
          "snoozeFilter": {
            "autoSnooze": 0,
            "snoozeScope": "Series",
            "onlyForSuccessive": true
          }
        },
        {
          "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
          "anomalyScopeType": "Dimension",
          "negationOperation": false,
          "dimensionAnomalyScope": {
            "dimension": {
              "city": "Beijing"
            }
          },
          "severityFilter": {
            "minAlertSeverity": "Low",
            "maxAlertSeverity": "High"
          },
          "snoozeFilter": {
            "autoSnooze": 0,
            "snoozeScope": "Series",
            "onlyForSuccessive": true
          },
          "valueFilter": {
            "lower": 0,
            "upper": 1000,
            "direction": "Both",
            "type": "Value"
          }
        }
      ]
    }
  ],
  "@nextLink": "string"
}
{
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "required": [
          "hookIds",
          "metricAlertingConfigurations",
          "name"
        ],
        "type": "object",
        "properties": {
          "anomalyAlertingConfigurationId": {
            "format": "uuid",
            "description": "anomaly alerting configuration unique id",
            "type": "string",
            "readOnly": true
          },
          "name": {
            "description": "anomaly alerting configuration name",
            "type": "string"
          },
          "description": {
            "description": "anomaly alerting configuration description",
            "default": "",
            "type": "string"
          },
          "crossMetricsOperator": {
            "description": "cross metrics operator\r\n\r\nshould be specified when setting up multiple metric alerting configurations",
            "enum": [
              "AND",
              "OR",
              "XOR"
            ],
            "type": "string",
            "x-ms-enum": {
              "name": "AnomalyAlertingConfigurationLogicType",
              "modelAsString": true
            }
          },
          "splitAlertByDimensions": {
            "description": "dimensions used to split alert",
            "uniqueItems": true,
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "hookIds": {
            "description": "hook unique ids",
            "uniqueItems": true,
            "type": "array",
            "items": {
              "format": "uuid",
              "type": "string"
            }
          },
          "metricAlertingConfigurations": {
            "description": "Anomaly alerting configurations",
            "uniqueItems": true,
            "type": "array",
            "items": {
              "required": [
                "anomalyDetectionConfigurationId",
                "anomalyScopeType"
              ],
              "type": "object",
              "properties": {
                "anomalyDetectionConfigurationId": {
                  "format": "uuid",
                  "description": "Anomaly detection configuration unique id",
                  "type": "string"
                },
                "anomalyScopeType": {
                  "description": "Anomaly scope",
                  "enum": [
                    "All",
                    "Dimension",
                    "TopN"
                  ],
                  "type": "string",
                  "example": "All",
                  "x-ms-enum": {
                    "name": "AnomalyScope",
                    "modelAsString": true
                  }
                },
                "negationOperation": {
                  "description": "Negation operation",
                  "default": false,
                  "type": "boolean"
                },
                "dimensionAnomalyScope": {
                  "required": [
                    "dimension"
                  ],
                  "type": "object",
                  "properties": {
                    "dimension": {
                      "description": "dimension specified for series group",
                      "type": "object",
                      "additionalProperties": {
                        "type": "string"
                      }
                    }
                  }
                },
                "topNAnomalyScope": {
                  "required": [
                    "minTopCount",
                    "period",
                    "top"
                  ],
                  "type": "object",
                  "properties": {
                    "top": {
                      "format": "int32",
                      "description": "top N, value range : [1, +∞)",
                      "type": "integer"
                    },
                    "period": {
                      "format": "int32",
                      "description": "point count used to look back, value range : [1, +∞)",
                      "type": "integer"
                    },
                    "minTopCount": {
                      "format": "int32",
                      "description": "min count should be in top N, value range : [1, +∞)\r\n\r\nshould be less than or equal to period",
                      "type": "integer"
                    }
                  }
                },
                "severityFilter": {
                  "required": [
                    "maxAlertSeverity",
                    "minAlertSeverity"
                  ],
                  "type": "object",
                  "properties": {
                    "minAlertSeverity": {
                      "description": "min alert severity",
                      "enum": [
                        "Low",
                        "Medium",
                        "High"
                      ],
                      "type": "string",
                      "x-ms-enum": {
                        "name": "Severity",
                        "modelAsString": true
                      }
                    },
                    "maxAlertSeverity": {
                      "description": "max alert severity",
                      "enum": [
                        "Low",
                        "Medium",
                        "High"
                      ],
                      "type": "string",
                      "x-ms-enum": {
                        "name": "Severity",
                        "modelAsString": true
                      }
                    }
                  }
                },
                "snoozeFilter": {
                  "required": [
                    "autoSnooze",
                    "onlyForSuccessive",
                    "snoozeScope"
                  ],
                  "type": "object",
                  "properties": {
                    "autoSnooze": {
                      "format": "int32",
                      "description": "snooze point count, value range : [0, +∞)",
                      "type": "integer"
                    },
                    "snoozeScope": {
                      "description": "snooze scope",
                      "enum": [
                        "Metric",
                        "Series"
                      ],
                      "type": "string",
                      "x-ms-enum": {
                        "name": "SnoozeScope",
                        "modelAsString": true
                      }
                    },
                    "onlyForSuccessive": {
                      "description": "only snooze for successive anomalies",
                      "type": "boolean"
                    }
                  }
                },
                "valueFilter": {
                  "required": [
                    "direction"
                  ],
                  "type": "object",
                  "properties": {
                    "lower": {
                      "format": "double",
                      "description": "lower bound\r\n\r\nshould be specified when direction is Both or Down",
                      "type": "number"
                    },
                    "upper": {
                      "format": "double",
                      "description": "upper bound\r\n\r\nshould be specified when direction is Both or Up",
                      "type": "number"
                    },
                    "direction": {
                      "description": "value filter direction",
                      "enum": [
                        "Both",
                        "Down",
                        "Up"
                      ],
                      "type": "string",
                      "x-ms-enum": {
                        "name": "Direction",
                        "modelAsString": true
                      }
                    },
                    "type": {
                      "description": "data used to implement value filter",
                      "default": "Value",
                      "enum": [
                        "Value",
                        "Mean"
                      ],
                      "type": "string",
                      "x-ms-enum": {
                        "name": "ValueType",
                        "modelAsString": true
                      }
                    },
                    "metricId": {
                      "format": "uuid",
                      "description": "the other metric unique id used for value filter",
                      "type": "string"
                    },
                    "triggerForMissing": {
                      "description": "trigger alert when the corresponding point is missing in the other metric\r\n\r\nshould be specified only when using other metric to filter",
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          }
        },
        "example": {
          "name": "alerting configuration name",
          "crossMetricsOperator": "AND",
          "hookIds": [
            "00000000-0000-0000-0000-000000000001"
          ],
          "metricAlertingConfigurations": [
            {
              "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000001",
              "anomalyScopeType": "All",
              "negationOperation": false,
              "severityFilter": {
                "minAlertSeverity": "Medium",
                "maxAlertSeverity": "High"
              },
              "snoozeFilter": {
                "autoSnooze": 0,
                "snoozeScope": "Series",
                "onlyForSuccessive": true
              }
            },
            {
              "anomalyDetectionConfigurationId": "33333333-3333-3333-3333-000000000002",
              "anomalyScopeType": "Dimension",
              "negationOperation": false,
              "dimensionAnomalyScope": {
                "dimension": {
                  "city": "Beijing"
                }
              },
              "severityFilter": {
                "minAlertSeverity": "Low",
                "maxAlertSeverity": "High"
              },
              "snoozeFilter": {
                "autoSnooze": 0,
                "snoozeScope": "Series",
                "onlyForSuccessive": true
              },
              "valueFilter": {
                "lower": 0,
                "upper": 1000,
                "direction": "Both",
                "type": "Value"
              }
            }
          ]
        }
      },
      "readOnly": true
    },
    "@nextLink": {
      "type": "string",
      "readOnly": true
    }
  }
}

Response 500

Client error or server error (4xx or 5xx)

{
  "message": "string",
  "code": "string"
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "code": {
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://*.cognitiveservices.azure.us/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}/alert/anomaly/configurations?$skip={integer}&$maxpagesize={integer}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["$skip"] = "{integer}";
            queryString["$maxpagesize"] = "{integer}";
            var uri = "https://*.cognitiveservices.azure.us/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}/alert/anomaly/configurations?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://*.cognitiveservices.azure.us/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}/alert/anomaly/configurations");

            builder.setParameter("$skip", "{integer}");
            builder.setParameter("$maxpagesize", "{integer}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "$skip": "{integer}",
            "$maxpagesize": "{integer}",
        };
      
        $.ajax({
            url: "https://*.cognitiveservices.azure.us/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}/alert/anomaly/configurations?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://*.cognitiveservices.azure.us/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}/alert/anomaly/configurations";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"$skip={integer}",
                         @"$maxpagesize={integer}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://*.cognitiveservices.azure.us/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}/alert/anomaly/configurations');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    '$skip' => '{integer}',
    '$maxpagesize' => '{integer}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    '$skip': '{integer}',
    '$maxpagesize': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('*.cognitiveservices.azure.us')
    conn.request("GET", "/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}/alert/anomaly/configurations?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    '$skip': '{integer}',
    '$maxpagesize': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('*.cognitiveservices.azure.us')
    conn.request("GET", "/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}/alert/anomaly/configurations?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://*.cognitiveservices.azure.us/metricsadvisor/v1.0/enrichment/anomalyDetection/configurations/{configurationId}/alert/anomaly/configurations')
uri.query = URI.encode_www_form({
    # Request parameters
    '$skip' => '{integer}',
    '$maxpagesize' => '{integer}'
})

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body