Microsoft Azure Metrics Advisor REST API v1.1-preview.1
Microsoft Azure Metrics Advisor REST API (v1.1-preview.1)
Query incidents under a specific alert
Query incidents under a specific alert
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request parameters
string
Format - uuid. anomaly alerting configuration unique id
string
alert 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
{
"@nextLink": "string",
"value": [
{
"dataFeedId": "string",
"metricId": "string",
"anomalyDetectionConfigurationId": "string",
"incidentId": "string",
"startTime": "string",
"lastTime": "string",
"rootNode": {
"dimension": {}
},
"property": {
"maxSeverity": "Low",
"incidentStatus": "Active",
"valueOfRootNode": 0.0,
"expectedValueOfRootNode": 0.0
}
}
]
}
{
"required": [
"value"
],
"type": "object",
"properties": {
"@nextLink": {
"type": "string",
"readOnly": true
},
"value": {
"type": "array",
"items": {
"required": [
"incidentId",
"lastTime",
"property",
"rootNode",
"startTime"
],
"type": "object",
"properties": {
"dataFeedId": {
"format": "uuid",
"description": "data feed unique id\r\n\r\nonly return for alerting anomaly result",
"type": "string",
"readOnly": true
},
"metricId": {
"format": "uuid",
"description": "metric unique id\r\n\r\nonly return for alerting incident result",
"type": "string",
"readOnly": true
},
"anomalyDetectionConfigurationId": {
"format": "uuid",
"description": "anomaly detection configuration unique id\r\n\r\nonly return for alerting incident result",
"type": "string",
"readOnly": true
},
"incidentId": {
"description": "incident id",
"type": "string"
},
"startTime": {
"format": "date-time",
"description": "incident start time",
"type": "string"
},
"lastTime": {
"format": "date-time",
"description": "incident last time",
"type": "string"
},
"rootNode": {
"required": [
"dimension"
],
"type": "object",
"properties": {
"dimension": {
"description": "dimension specified for series",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"property": {
"required": [
"maxSeverity"
],
"type": "object",
"properties": {
"maxSeverity": {
"description": "max severity of latest anomalies in the incident",
"enum": [
"Low",
"Medium",
"High"
],
"type": "string",
"x-ms-enum": {
"name": "Severity",
"modelAsString": true
}
},
"incidentStatus": {
"description": "incident status\r\n\r\nonly return for alerting incident result",
"enum": [
"Active",
"Resolved"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "IncidentStatus",
"modelAsString": true
}
},
"valueOfRootNode": {
"format": "double",
"description": "value of the root node",
"type": "number",
"readOnly": true
},
"expectedValueOfRootNode": {
"format": "double",
"description": "expected value of the root node given by smart detector",
"type": "number",
"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://norwayeast.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/alert/anomaly/configurations/{configurationId}/alerts/{alertId}/incidents?$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://norwayeast.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/alert/anomaly/configurations/{configurationId}/alerts/{alertId}/incidents?" + 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://norwayeast.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/alert/anomaly/configurations/{configurationId}/alerts/{alertId}/incidents");
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://norwayeast.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/alert/anomaly/configurations/{configurationId}/alerts/{alertId}/incidents?" + $.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://norwayeast.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/alert/anomaly/configurations/{configurationId}/alerts/{alertId}/incidents";
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://norwayeast.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/alert/anomaly/configurations/{configurationId}/alerts/{alertId}/incidents');
$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('norwayeast.api.cognitive.microsoft.com')
conn.request("GET", "/metricsadvisor/v1.1-preview.1/alert/anomaly/configurations/{configurationId}/alerts/{alertId}/incidents?%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('norwayeast.api.cognitive.microsoft.com')
conn.request("GET", "/metricsadvisor/v1.1-preview.1/alert/anomaly/configurations/{configurationId}/alerts/{alertId}/incidents?%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://norwayeast.api.cognitive.microsoft.com/metricsadvisor/v1.1-preview.1/alert/anomaly/configurations/{configurationId}/alerts/{alertId}/incidents')
query = URI.encode_www_form({
# Request parameters
'$skip' => '{integer}',
'$maxpagesize' => '{integer}'
})
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