The Anomaly Detector API detects anomalies automatically in time series data. It supports two kinds of mode, one is for stateless using, another is for stateful using. In stateless mode, there are three functionalities. Entire Detect is for detecting the whole series with model trained by the time series, Last Detect is detecting last point with model trained by points before. ChangePoint Detect is for detecting trend changes in time series.
swagger: '2.0'
info:
title: Microsoft Azure Anomaly Detector Client
description: >-
Root cause analysis(RCA) helps drill down the crucial dimension combinations
that contribute most to the given anomaly point. By learning the
relationship among metrics, our algorithm supports finding root cause from
both single and multiple measures, as well as providing reasonable
interpretation.
version: 1.1-preview.2
paths:
/rootCauseAnalysis/dataSets/{dataSetId}:
put:
tags:
- RootCauseAnalysisDataSet
summary: Microsoft Azure Create A Root Cause Analysis Data Set
operationId: microsoftAzureCreaterootcauseanalysisdataset
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: dataSetId
description: >-
The root cause analysis data set unique id, should be a string of
uuid
required: true
type: string
format: uuid
- in: body
name: body
description: create a root cause analysis data set request
required: true
schema:
$ref: '#/definitions/CreateRootCauseAnalysisDataSet'
responses:
'201':
description: Success
headers:
Location:
description: Location of the newly created resource.
type: string
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Create a root cause analysis data set:
$ref: ./examples/CreateRootCauseAnalysisDataSet.json
description: Needs a more full description created.
get:
tags:
- RootCauseAnalysisDataSet
summary: Microsoft Azure Get A Root Cause Analysis Data Set By Its Id
operationId: microsoftAzureGetrootcauseanalysisdataset
produces:
- application/json
parameters:
- in: path
name: dataSetId
description: >-
The root cause analysis data set unique id, should be a string of
uuid
required: true
type: string
format: uuid
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RootCauseAnalysisDataSet'
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Get a root cause analysis data set by its id:
$ref: ./examples/GetRootCauseAnalysisDataSet.json
description: Needs a more full description created.
delete:
tags:
- RootCauseAnalysisDataSet
summary: Microsoft Azure Delete A Root Cause Analysis Data Set
operationId: microsoftAzureDeleterootcauseanalysisdataset
produces:
- application/json
parameters:
- in: path
name: dataSetId
description: >-
The root cause analysis data set unique id, should be a string of
uuid
required: true
type: string
format: uuid
responses:
'204':
description: The resource is deleted successfully or does not exist.
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Delete a root cause analysis data set:
$ref: ./examples/DeleteRootCauseAnalysisDataSet.json
description: Needs a more full description created.
/rootCauseAnalysis/dataSets:
get:
tags:
- RootCauseAnalysisDataSet
summary: Microsoft Azure List Root Cause Analysis Data Sets
operationId: microsoftAzureListrootcauseanalysisdatasets
produces:
- application/json
parameters:
- in: query
name: skip
description: For paging, skipped number
type: integer
format: int32
- in: query
name: maxpagesize
description: The maximum number of items in one page
type: integer
format: int32
- in: query
name: filter
description: >-
The filter expression filters out the resources to be returned,
currently contains(displayName, 'filter name’) is supported
type: string
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RootCauseAnalysisDataSetList'
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List root cause analysis data sets:
$ref: ./examples/ListRootCauseAnalysisDataSets.json
description: Needs a more full description created.
/rootCauseAnalysis/dataSets/{dataSetId}/timestamps/{timestamp}/partitions/{partitionId}:
put:
tags:
- RootCauseAnalysisDataSet
summary: Microsoft Azure Upload Data To Root Cause Analysis Data Set By Partition
operationId: microsoftAzureUploadrootcauseanalysisdatabypartition
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: dataSetId
description: >-
The root cause analysis data set unique id. Should be a string of
uuid
required: true
type: string
format: uuid
- in: path
name: timestamp
description: Timestamp of the data, should be a string of ISO format
required: true
type: string
format: date-time
- in: path
name: partitionId
description: The partition unique id，should be a string of uuid
required: true
type: string
format: uuid
- in: body
name: body
description: Data to be uploaded to perform root cause analysis
required: true
schema:
$ref: '#/definitions/RootCauseAnalysisUploadDataPartitionRequest'
responses:
'201':
description: Success
headers:
Location:
description: Location of the newly created resource.
type: string
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Upload data to root cause analysis data set by partition:
$ref: ./examples/UploadRootCauseAnalysisDataByPartition.json
description: Needs a more full description created.
delete:
tags:
- RootCauseAnalysisDataSet
summary: Microsoft Azure Delete Root Cause Analysis Data By Partition Id
operationId: microsoftAzureDeleterootcauseanalysisdatabypartitionid
produces:
- application/json
parameters:
- in: path
name: dataSetId
description: Data set unique id，should be a string of uuid
required: true
type: string
format: uuid
- in: path
name: timestamp
description: The time stamp to be queried, should be a string of ISO format
required: true
type: string
format: date-time
- in: path
name: partitionId
description: Data partition unique id，should be a string of uuid
required: true
type: string
format: uuid
responses:
'204':
description: The resource is deleted successfully or does not exist.
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Delete root cause analysis data by partition Id:
$ref: ./examples/DeleteRootCauseAnalysisDataByPartitionId.json
description: Needs a more full description created.
/rootCauseAnalysis/dataSets/{dataSetId}/timestamps:upload:
post:
tags:
- RootCauseAnalysisDataSet
summary: Microsoft Azure Upload Data To Root Cause Analysis Data Set By Block
operationId: microsoftAzureUploadrootcauseanalysisdatabyblock
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: dataSetId
description: >-
The root cause analysis data set unique id，should be a string of
uuid
required: true
type: string
format: uuid
- in: body
name: body
description: Data to be uploaded to perform root cause analysis
required: true
schema:
$ref: '#/definitions/RootCauseAnalysisUploadDataBlockRequest'
responses:
'201':
description: Success
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Upload data to root cause analysis data set by block:
$ref: ./examples/UploadRootCauseAnalysisDataByBlock.json
description: Needs a more full description created.
/rootCauseAnalysis/dataSets/{dataSetId}/timestamps:purge:
post:
tags:
- RootCauseAnalysisDataSet
summary: Microsoft Azure Delete Root Cause Analysis Data By Time Range
operationId: microsoftAzureDeleterootcauseanalysisdatabytimerange
produces:
- application/json
parameters:
- in: path
name: dataSetId
description: >-
The root cause analysis data set unique id，should be a string of
uuid
required: true
type: string
format: uuid
- in: query
name: start
description: Start date time, should be ISO format
type: string
- in: query
name: end
description: End date time, should be ISO format
type: string
responses:
'204':
description: Success
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Delete root cause analysis data by time range:
$ref: ./examples/DeleteRootCauseAnalysisDataByTimeRange.json
description: Needs a more full description created.
/rootCauseAnalysis/dataSets/{dataSetId}/timestamps/{timestamp}/partitions:
get:
tags:
- RootCauseAnalysisDataSet
summary: Microsoft Azure List Data Meta For A Given Timestamp
operationId: microsoftAzureListrootcauseanalysisdatametabytimestamp
produces:
- application/json
parameters:
- in: path
name: dataSetId
description: >-
The root cause analysis data set unique id, should be a string of
uuid
required: true
type: string
format: uuid
- in: path
name: timestamp
description: The time stamp to be queried, should be a string of ISO format
required: true
type: string
format: date-time
- in: query
name: skip
description: For paging, skipped number
type: integer
format: int32
- in: query
name: maxpagesize
description: The maximum number of items in one page
type: integer
format: int32
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RootCauseAnalysisDataMetaListResponse'
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List data meta for a given timestamp:
$ref: ./examples/ListRootCauseAnalysisDataMetaByTimestamp.json
description: Needs a more full description created.
/rootCauseAnalysis/dataSets/{dataSetId}/timestamps:
get:
tags:
- RootCauseAnalysisDataSet
summary: Microsoft Azure List Data Meta
operationId: microsoftAzureListrootcauseanalysisdatametabytimerange
produces:
- application/json
parameters:
- in: path
name: dataSetId
description: >-
The root cause analysis data set unique id, should be a string of
uuid
required: true
type: string
format: uuid
- in: query
name: skip
description: For paging, skipped number
type: integer
format: int32
- in: query
name: maxpagesize
description: The maximum number of items in one page
type: integer
format: int32
- in: query
name: filter
description: >-
The filter expression filters out the resources, currently 2 kinds
of operation are supported. They are timestamp ge XXXX and timestamp
le XXXX. Timestamp must be ISO format
type: string
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RootCauseAnalysisDataMetaListResponse'
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List data meta:
$ref: ./examples/ListRootCauseAnalysisDataMetaByTimeRange.json
description: Needs a more full description created.
/rootCauseAnalysis/instances/{instanceId}:
put:
tags:
- RootCauseAnalysisInstance
summary: Microsoft Azure Create An Instance For Root Cause Analysis
operationId: microsoftAzureCreaterootcauseanalysisinstance
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: instanceId
description: Instance unique id, should be a string of uuid.
required: true
type: string
format: uuid
- in: body
name: body
description: Create a root cause analysis instance request
required: true
schema:
$ref: '#/definitions/CreateRootCauseAnalysisInstance'
responses:
'201':
description: Success
headers:
Location:
description: Location of the newly created resource.
type: string
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Create an instance for root cause analysis:
$ref: ./examples/CreateRootCauseAnalysisInstance.json
description: Needs a more full description created.
get:
tags:
- RootCauseAnalysisInstance
summary: Microsoft Azure Query An Instance Information For Root Cause Analysis
operationId: microsoftAzureGetrootcauseanalysisinstance
produces:
- application/json
parameters:
- in: path
name: instanceId
description: Instance unique id, should be a string of uuid.
required: true
type: string
format: uuid
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RootCauseAnalysisInstance'
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Query an instance information for root cause analysis:
$ref: ./examples/GetRootCauseAnalysisInstance.json
description: Needs a more full description created.
delete:
tags:
- RootCauseAnalysisInstance
summary: Microsoft Azure Delete An Instance For Root Cause Analysis
operationId: microsoftAzureDeleterootcauseanalysisinstance
produces:
- application/json
parameters:
- in: path
name: instanceId
description: Instance unique id
required: true
type: string
format: uuid
responses:
'204':
description: The resource is deleted successfully or does not exist.
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Delete an instance for root cause analysis:
$ref: ./examples/DeleteRootCauseAnalysisInstance.json
description: Needs a more full description created.
/rootCauseAnalysis/instances:
get:
tags:
- RootCauseAnalysisInstance
summary: Microsoft Azure Get Instance List For Root Cause Analysis
operationId: microsoftAzureListrootcauseanalysisinstances
produces:
- application/json
parameters:
- in: query
name: skip
description: For paging, skipped number
type: integer
format: int32
- in: query
name: maxpagesize
description: The maximum number of items in one page
type: integer
format: int32
- in: query
name: filter
description: >-
The filter expression filters out the resources to be returned,
currently contains(displayName, 'filter name’) is supported
type: string
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RootCauseAnalysisInstanceResponseList'
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
Get instance list for root cause analysis:
$ref: ./examples/ListRootCauseAnalysisInstances.json
description: Needs a more full description created.
/rootCauseAnalysis/kinds:
get:
tags:
- RootCauseAnalysisKind
summary: Microsoft Azure Get Kind List For Root Cause Analysis
operationId: microsoftAzureListrootcauseanalysiskinds
produces:
- application/json
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RootCauseAnalysisKindList'
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Get kind list for root cause analysis:
$ref: ./examples/ListRootCauseAnalysisKinds.json
description: Needs a more full description created.
/rootCauseAnalysis/instances/{instanceId}/models/{modelId}:
put:
tags:
- RootCauseAnalysisModel
summary: Microsoft Azure Create A Training Model For Root Cause Analysis
operationId: microsoftAzureCreaterootcauseanalysistrainingtask
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: instanceId
description: Instance unique id, should be a string of uuid
required: true
type: string
format: uuid
- in: path
name: modelId
description: Model unique id, should be a string of uuid
required: true
type: string
format: uuid
- in: body
name: body
required: true
schema:
$ref: '#/definitions/RootCauseAnalysisTrainingRequest'
responses:
'201':
description: Success
schema:
$ref: '#/definitions/RootCauseAnalysisTrainingResponse'
examples:
application/json:
taskId: 11111111-1111-4444-4444-000000000000
instanceId: 11111111-2222-3333-4444-000000000000
modelId: 11223344-5555-6666-7777-000000000000
displayName: Sample Root Cause Analysis Model Name
kind: multidimensional
status: scheduled
createdDateTime: '2021-12-01T00:00:00Z'
lastModifiedDateTime: '2021-12-01T00:00:00Z'
parameter:
startDateTime: '2021-05-01T00:00:00Z'
endDateTime: '2021-09-01T00:00:00Z'
headers:
Location:
description: Location of the newly created resource.
type: string
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Create a training model for root cause analysis:
$ref: ./examples/CreateRootCauseAnalysisTrainingTask.json
description: Needs a more full description created.
delete:
tags:
- RootCauseAnalysisModel
summary: Microsoft Azure Delete A Model For Root Cause Analysis
operationId: microsoftAzureDeleterootcauseanalysismodel
produces:
- application/json
parameters:
- in: path
name: instanceId
description: Instance unique id, should be a string of uuid.
required: true
type: string
format: uuid
- in: path
name: modelId
description: Model unique id, should be a string of uuid.
required: true
type: string
format: uuid
responses:
'204':
description: The resource is deleted successfully or does not exist.
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Delete a model for root cause analysis:
$ref: ./examples/DeleteRootCauseAnalysisModel.json
description: Needs a more full description created.
get:
tags:
- RootCauseAnalysisModel
summary: Microsoft Azure Query A Training Task State For Root Cause Analysis
operationId: microsoftAzureGetrootcauseanalysistrainingstate
produces:
- application/json
parameters:
- in: path
name: instanceId
description: Instance unique id, should be a string of uuid.
required: true
type: string
format: uuid
- in: path
name: modelId
description: Model unique id, should be a string of uuid.
required: true
type: string
format: uuid
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RootCauseAnalysisTrainingResponse'
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Query a training task state for root cause analysis:
$ref: ./examples/GetRootCauseAnalysisTrainingState.json
description: Needs a more full description created.
/rootCauseAnalysis/instances/{instanceId}/models:
get:
tags:
- RootCauseAnalysisModel
summary: Microsoft Azure Query Training Task State List For Root Cause Analysis
operationId: microsoftAzureListrootcauseanalysistrainingstates
produces:
- application/json
parameters:
- in: path
name: instanceId
description: Instance unique id, should be a string of uuid.
required: true
type: string
format: uuid
- in: query
name: skip
description: For paging, skipped number
type: integer
format: int32
- in: query
name: maxpagesize
description: The maximum number of items in one page
type: integer
format: int32
- in: query
name: filter
description: >-
The filter expression filters out the resources to be returned,
currently contains(displayName, 'filter name’) is supported
type: string
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RootCauseAnalysisTrainingResponseList'
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
Query training task state list for root cause analysis:
$ref: ./examples/ListRootCauseAnalysisTrainingStates.json
description: Needs a more full description created.
/rootCauseAnalysis/instances/{instanceId}/models/{modelId}/inferences/{inferenceId}:
put:
tags:
- RootCauseAnalysisModel
summary: Microsoft Azure Create An Inference Task For Root Cause Analysis
operationId: microsoftAzureCreaterootcauseanalysisinferencetask
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: instanceId
description: Instance unique id, should be a string of uuid.
required: true
type: string
format: uuid
- in: path
name: modelId
description: Model unique id, should be a string of uuid.
required: true
type: string
format: uuid
- in: path
name: inferenceId
description: Inference unique id, should be a string of uuid.
required: true
type: string
format: uuid
- in: body
name: body
description: Inference request of root cause analysis
required: true
schema:
$ref: '#/definitions/RootCauseAnalysisInferenceRequest'
responses:
'201':
description: Success
schema:
$ref: '#/definitions/RootCauseAnalysisInferenceResponse'
examples:
application/json:
inferenceId: 11111111-1111-1111-1111-000000000000
instanceId: 11111111-2222-3333-4444-000000000000
modelId: 11223344-5555-6666-7777-000000000000
kind: multidimensional
status: scheduled
createdDateTime: '2021-12-01T00:00:00Z'
lastModifiedDateTime: '2021-12-01T00:00:00Z'
parameter:
timestamp: '2021-06-04T00:00:00Z'
dimensionScope: {}
headers:
Location:
description: Location of the newly created resource.
type: string
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Create an inference task for root cause analysis:
$ref: ./examples/CreateRootCauseAnalysisInferenceTask.json
description: Needs a more full description created.
get:
tags:
- RootCauseAnalysisModel
summary: Microsoft Azure Query An Inference Task State For Root Cause Analysis
operationId: microsoftAzureGetrootcauseanalysisinferencestate
produces:
- application/json
parameters:
- in: path
name: instanceId
description: Instance unique id, should be a string of uuid.
required: true
type: string
format: uuid
- in: path
name: modelId
description: Model unique id, should be a string of uuid.
required: true
type: string
format: uuid
- in: path
name: inferenceId
description: Inference unique id, should be a string of uuid.
required: true
type: string
format: uuid
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RootCauseAnalysisInferenceResponse'
default:
description: Client error or server error (4xx or 5xx)
schema:
$ref: '#/definitions/ErrorDetail'
headers:
x-ms-error-code:
description: error code
type: string
x-ms-examples:
Query an inference task state for root cause analysis:
$ref: ./examples/GetRootCauseAnalysisInferenceState.json
description: Needs a more full description created.
definitions:
RootCauseAnalysisMeasure:
required:
- displayName
type: object
properties:
displayName:
description: Root cause analysis measure name
type: string
CreateRootCauseAnalysisDataSet:
required:
- displayName
- kind
type: object
properties:
kind:
description: Root cause analysis kind
enum:
- multidimensional
type: string
x-ms-enum:
name: RootCauseAnalysisType
modelAsString: true
displayName:
description: Root cause analysis data set name
type: string
discriminator: kind
example:
granularity: daily
customInterval: 1
dimensionKeys:
- Region
- Platform
aggregatedIdentifier: __AGG__
measures:
- displayName: Failure Rate
- displayName: Error Count
- displayName: Total Count
displayName: Sample Multidimensional Root Cause Analysis Dataset Name
kind: multidimensional
CreateMultiDimRCADataSet:
required:
- aggregatedIdentifier
- customInterval
- dimensionKeys
- granularity
- measures
type: object
allOf:
- $ref: '#/definitions/CreateRootCauseAnalysisDataSet'
properties:
granularity:
description: Multidimensional root cause data set granularity
enum:
- yearly
- monthly
- weekly
- daily
- hourly
- minutely
- secondly
- microsecond
- none
type: string
x-ms-enum:
name: Granularity
# --- truncated at 32 KB (497 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/anomaly-detector-client-openapi-original.yml