AnomalyDetector.EE

Project "Gualala"

Query a single anomaly alerting configuration

Query a single anomaly alerting 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 alerting configuration unique id

Request headers

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

Request body

Response 200

Success

{
  "anomalyAlertingConfigurationId": "44444444-4444-4444-4444-000000000001",
  "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",
        "triggerForMissing": false
      }
    }
  ]
}
{
  "required": [
    "crossMetricsOperator",
    "hookIds",
    "metricAlertingConfigurations",
    "name"
  ],
  "type": "object",
  "properties": {
    "anomalyAlertingConfigurationId": {
      "type": "string",
      "description": "Anomaly alerting configuration unique id",
      "format": "uuid",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "Anomaly alerting configuration name"
    },
    "crossMetricsOperator": {
      "enum": [
        "AND",
        "OR",
        "XOR"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "AnomalyAlertingConfigurationLogicType",
        "modelAsString": true
      }
    },
    "hookIds": {
      "uniqueItems": true,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "hook unique ids"
    },
    "metricAlertingConfigurations": {
      "uniqueItems": true,
      "type": "array",
      "items": {
        "required": [
          "anomalyDetectionConfigurationId",
          "anomalyScopeType",
          "negationOperation"
        ],
        "type": "object",
        "properties": {
          "anomalyDetectionConfigurationId": {
            "type": "string",
            "description": "Anomaly detection configuration unique id",
            "format": "uuid"
          },
          "anomalyScopeType": {
            "enum": [
              "All",
              "Dimension",
              "TopN"
            ],
            "type": "string",
            "x-ms-enum": {
              "name": "AnomalyScope",
              "modelAsString": true
            }
          },
          "negationOperation": {
            "type": "boolean",
            "description": "Negation operation"
          },
          "dimensionAnomalyScope": {
            "required": [
              "dimension"
            ],
            "type": "object",
            "properties": {
              "dimension": {
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                },
                "description": "dimension specified for series group"
              }
            },
            "additionalProperties": false
          },
          "topNAnomalyScope": {
            "required": [
              "minTopCount",
              "period",
              "top"
            ],
            "type": "object",
            "properties": {
              "top": {
                "type": "integer",
                "description": "top N, value range : [1, +∞)",
                "format": "int32"
              },
              "period": {
                "type": "integer",
                "description": "point count used to look back, value range : [1, +∞)",
                "format": "int32"
              },
              "minTopCount": {
                "type": "integer",
                "description": "min count should be in top N, value range : [1, +∞)\r\n\r\nshould be less than or equal to period",
                "format": "int32"
              }
            },
            "additionalProperties": false
          },
          "severityFilter": {
            "required": [
              "maxAlertSeverity",
              "minAlertSeverity"
            ],
            "type": "object",
            "properties": {
              "minAlertSeverity": {
                "enum": [
                  "Low",
                  "Medium",
                  "High"
                ],
                "type": "string",
                "x-ms-enum": {
                  "name": "Severity",
                  "modelAsString": true
                }
              },
              "maxAlertSeverity": {
                "enum": [
                  "Low",
                  "Medium",
                  "High"
                ],
                "type": "string",
                "x-ms-enum": {
                  "name": "Severity",
                  "modelAsString": true
                }
              }
            },
            "additionalProperties": false
          },
          "snoozeFilter": {
            "required": [
              "autoSnooze",
              "onlyForSuccessive",
              "snoozeScope"
            ],
            "type": "object",
            "properties": {
              "autoSnooze": {
                "type": "integer",
                "description": "snooze point count, value range : [0, +∞)",
                "format": "int32"
              },
              "snoozeScope": {
                "enum": [
                  "Metric",
                  "Series"
                ],
                "type": "string",
                "x-ms-enum": {
                  "name": "SnoozeScope",
                  "modelAsString": true
                }
              },
              "onlyForSuccessive": {
                "type": "boolean",
                "description": "only snooze for successive anomalies"
              }
            },
            "additionalProperties": false
          },
          "valueFilter": {
            "required": [
              "direction"
            ],
            "type": "object",
            "properties": {
              "lower": {
                "type": "number",
                "description": "lower bound\r\n\r\nshould be specified when direction is Both or Down",
                "format": "double",
                "nullable": true
              },
              "upper": {
                "type": "number",
                "description": "upper bound\r\n\r\nshould be specified when direction is Both or Up",
                "format": "double",
                "nullable": true
              },
              "direction": {
                "enum": [
                  "Both",
                  "Down",
                  "Up"
                ],
                "type": "string",
                "x-ms-enum": {
                  "name": "Direction",
                  "modelAsString": true
                }
              },
              "metricId": {
                "type": "string",
                "description": "the other metric unique id used for value filter",
                "format": "uuid",
                "nullable": true
              },
              "triggerForMissing": {
                "type": "boolean",
                "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"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "description": "Anomaly alerting configurations"
    }
  },
  "additionalProperties": false
}

Response 400

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

{
  "message": "string",
  "code": 0
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "code": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Response 500

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

{
  "message": "string",
  "code": 0
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "code": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Code samples

@ECHO OFF

curl -v -X GET "https://westus.api.cognitive.microsoft.com/anomalydetector-ee/v1.0/alert/anomaly/configurations/{configurationId}"
-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}");

            var uri = "https://westus.api.cognitive.microsoft.com/anomalydetector-ee/v1.0/alert/anomaly/configurations/{configurationId}?" + 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://westus.api.cognitive.microsoft.com/anomalydetector-ee/v1.0/alert/anomaly/configurations/{configurationId}");


            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
        };
      
        $.ajax({
            url: "https://westus.api.cognitive.microsoft.com/anomalydetector-ee/v1.0/alert/anomaly/configurations/{configurationId}?" + $.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://westus.api.cognitive.microsoft.com/anomalydetector-ee/v1.0/alert/anomaly/configurations/{configurationId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    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://westus.api.cognitive.microsoft.com/anomalydetector-ee/v1.0/alert/anomaly/configurations/{configurationId}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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({
})

try:
    conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/anomalydetector-ee/v1.0/alert/anomaly/configurations/{configurationId}?%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({
})

try:
    conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/anomalydetector-ee/v1.0/alert/anomaly/configurations/{configurationId}?%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://westus.api.cognitive.microsoft.com/anomalydetector-ee/v1.0/alert/anomaly/configurations/{configurationId}')
uri.query = URI.encode_www_form({
})

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