Microsoft Azure RootCauseAnalysisInstance API

openapi: 3.2.0
info:
  title: Microsoft Azure Anomaly Detector Client Root Cause Analysis…
  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
security:
- apiKeyHeader: []
tags:
- name: RootCauseAnalysisInstance
paths:
  /rootCauseAnalysis/instances/{instanceId}:
    put:
      tags:
      - RootCauseAnalysisInstance
      summary: Microsoft Azure Create An Instance For Root Cause Analysis
      operationId: microsoftAzureCreaterootcauseanalysisinstance
      parameters:
      - in: path
        name: instanceId
        description: Instance unique id, should be a string of uuid.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '201':
          description: Success
          headers:
            Location:
              description: Location of the newly created resource.
              schema:
                type: string
        default:
          description: Client error or server error (4xx or 5xx)
          headers:
            x-ms-error-code:
              description: error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
      x-ms-examples:
        Create an instance for root cause analysis:
          $ref: ./examples/CreateRootCauseAnalysisInstance.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRootCauseAnalysisInstance'
        description: Create a root cause analysis instance request
        required: true
    get:
      tags:
      - RootCauseAnalysisInstance
      summary: Microsoft Azure Query An Instance Information For Root Cause Analysis
      operationId: microsoftAzureGetrootcauseanalysisinstance
      parameters:
      - in: path
        name: instanceId
        description: Instance unique id, should be a string of uuid.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RootCauseAnalysisInstance'
        default:
          description: Client error or server error (4xx or 5xx)
          headers:
            x-ms-error-code:
              description: error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
      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
      parameters:
      - in: path
        name: instanceId
        description: Instance unique id
        required: true
        schema:
          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)
          headers:
            x-ms-error-code:
              description: error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
      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
      parameters:
      - in: query
        name: skip
        description: For paging, skipped number
        schema:
          type: integer
          format: int32
      - in: query
        name: maxpagesize
        description: The maximum number of items in one page
        schema:
          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
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RootCauseAnalysisInstanceResponseList'
        default:
          description: Client error or server error (4xx or 5xx)
          headers:
            x-ms-error-code:
              description: error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
      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.
components:
  schemas:
    RootCauseAnalysisInstance:
      required:
      - displayName
      - instanceId
      - kind
      type: object
      properties:
        kind:
          description: Root cause analysis type
          enum:
          - multidimensional
          type: string
          x-ms-enum:
            name: RootCauseAnalysisType
            modelAsString: true
        instanceId:
          format: uuid
          description: Instance unique ID for root cause analysis
          type: string
        displayName:
          description: Instance name for root cause analysis
          type: string
      discriminator:
        propertyName: kind
    RootCauseAnalysisInstanceResponseList:
      required:
      - value
      type: object
      properties:
        nextLink:
          description: Link of next page, only provided when there are next pages
          type: string
        value:
          description: Response values
          type: array
          items:
            $ref: '#/components/schemas/RootCauseAnalysisInstance'
    ErrorDetail:
      type: object
      properties:
        message:
          description: Human-readable error message
          type: string
        code:
          description: Error code
          type: string
    CreateRootCauseAnalysisInstance:
      required:
      - displayName
      - kind
      type: object
      properties:
        kind:
          description: Root cause analysis type
          enum:
          - multidimensional
          type: string
          x-ms-enum:
            name: RootCauseAnalysisType
            modelAsString: true
        displayName:
          description: Instance name for root cause analysis
          type: string
      discriminator:
        propertyName: kind
      example:
        targetMeasure:
          dataSetId: 01234567-8901-2345-6789-012345678901
          measureName: Failure Rate
        assistiveMeasures:
        - dataSetId: 01234567-8901-2345-6789-012345678901
          measureName: Error Count
        - dataSetId: 01234567-8901-2345-6789-012345678901
          measureName: Total Count
        displayName: Sample Root Cause Analysis Instance Name
        kind: multidimensional
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
      description: The secret key for your Azure Cognitive Services subscription.
x-ms-parameterized-host:
  hostTemplate: '{Endpoint}/anomalydetector/{ApiVersion}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'
  - $ref: '#/components/parameters/ApiVersion'