Anomaly Detector v1.1-preview.1

The Anomaly Detection service detects anomalies automatically in time series data. It supports several functionalities, one is for detecting anomalies in single time-series, including entire, last and change point detection. The other is detecting anomalies in multiple time-series. With univariate anomaly detection ability, business customers can discover incidents and establish a logic flow for root cause analysis. The multivariate anomaly detection APIs in Anomaly Detector analyze dependencies and inter-correlations between different signals. It enables customers to gather a group of related time-series and detect failures with a wholistic view. To ensure online service quality is one of the main reasons we developed this service. Our team is dedicated to continuing to improve the anomaly detection service to provide precise results.

This Multivariate Anomaly Detection is currently available in:

  • East US - eastus.api.cognitive.microsoft.com
  • East US 2 - eastus2.api.cognitive.microsoft.com
  • South Central US - southcentralus.api.cognitive.microsoft.com
  • UK South - uksouth.api.cognitive.microsoft.com
  • West Europe - westeurope.api.cognitive.microsoft.com
  • West US 2 - westus2.api.cognitive.microsoft.com

Multivariate Anomaly Detection - List Multivariate Models

List models of a subscription

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

Open API testing console

Request URL

Request parameters

(optional)
integer

$skip indicates how many models will be skipped.

(optional)
integer

$top indicates how many models will be fetched.

Request headers

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

Request body

Response 200

List multivariate model status successfully.

{
        "models": [
          {
            "modelId": "45aad126-aafd-11ea-b8fb-d89ef3400c5f",
            "createdTime": "2020-06-30T00:00:00Z",
            "lastUpdatedTime": "2020-06-30T00:00:00Z",
            "status": "READY",
            "displayName": "DevOps-MultiAD",
            "variablesCount": 18
          }
        ],
        "currentCount": 1,
        "maxCount": 20,
        "nextLink": ""
}
{
  "required": [
    "currentCount",
    "maxCount",
    "models"
  ],
  "properties": {
    "models": {
      "type": "array",
      "description": "List of models",
      "items": {
        "required": [
          "createdTime",
          "lastUpdatedTime",
          "modelId",
          "status",
          "variablesCount"
        ],
        "properties": {
          "modelId": {
            "type": "string",
            "format": "uuid",
            "description": "Model identifier.",
            "example": "45aad126-aafd-11ea-b8fb-d89ef3400c5f"
          },
          "createdTime": {
            "type": "string",
            "format": "date-time",
            "description": "Date and time (UTC) when the model was created.",
            "example": "2020-06-30T00:00:00Z"
          },
          "lastUpdatedTime": {
            "type": "string",
            "format": "date-time",
            "description": "Date and time (UTC) when the model was last updated.",
            "example": "2020-06-30T00:00:00Z"
          },
          "status": {
            "type": "string",
            "description": "Model training status.",
            "x-ms-enum": {
              "name": "modelStatus",
              "modelAsString": false
            },
            "example": "READY",
            "readOnly": true,
            "enum": [
              "CREATED",
              "RUNNING",
              "READY",
              "FAILED"
            ]
          },
          "displayName": {
            "type": "string",
            "example": "DevOps-Test"
          },
          "variablesCount": {
            "type": "integer",
            "description": "Total number of variables.",
            "example": 18
          }
        },
        "type": "object"
      }
    },
    "currentCount": {
      "type": "integer",
      "description": "Current count of trained multivariate models.",
      "example": 10
    },
    "maxCount": {
      "type": "integer",
      "description": "Max number of models that can be trained for this subscription.",
      "example": 20
    },
    "nextLink": {
      "type": "string",
      "description": "The link to fetch more models."
    }
  },
  "type": "object",
  "description": "Response of listing models."
}

Response 500

Internal Server Error.

Response 403

The certificate you provided is not accepted by server.

Response 405

Method Not Allowed.

Code samples

@ECHO OFF

curl -v -X GET "https://switzerlandwest.api.cognitive.microsoft.com/anomalydetector/v1.1-preview.1/multivariate/models?$skip=0&$top=5"
-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"] = "0";
            queryString["$top"] = "5";
            var uri = "https://switzerlandwest.api.cognitive.microsoft.com/anomalydetector/v1.1-preview.1/multivariate/models?" + 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://switzerlandwest.api.cognitive.microsoft.com/anomalydetector/v1.1-preview.1/multivariate/models");

            builder.setParameter("$skip", "0");
            builder.setParameter("$top", "5");

            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": "0",
            "$top": "5",
        };
      
        $.ajax({
            url: "https://switzerlandwest.api.cognitive.microsoft.com/anomalydetector/v1.1-preview.1/multivariate/models?" + $.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://switzerlandwest.api.cognitive.microsoft.com/anomalydetector/v1.1-preview.1/multivariate/models";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"$skip=0",
                         @"$top=5",
                      ];
    
    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://switzerlandwest.api.cognitive.microsoft.com/anomalydetector/v1.1-preview.1/multivariate/models');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    '$skip' => '0',
    '$top' => '5',
);

$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': '0',
    '$top': '5',
})

try:
    conn = httplib.HTTPSConnection('switzerlandwest.api.cognitive.microsoft.com')
    conn.request("GET", "/anomalydetector/v1.1-preview.1/multivariate/models?%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': '0',
    '$top': '5',
})

try:
    conn = http.client.HTTPSConnection('switzerlandwest.api.cognitive.microsoft.com')
    conn.request("GET", "/anomalydetector/v1.1-preview.1/multivariate/models?%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://switzerlandwest.api.cognitive.microsoft.com/anomalydetector/v1.1-preview.1/multivariate/models')

query = URI.encode_www_form({
    # Request parameters
    '$skip' => '0',
    '$top' => '5'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

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