> ## Documentation Index
> Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the distribution state

> Returns the distribution state of the given query cube, as the messages received from its data cubes and the JGroups membership notifications left it. The state is reported for the query cube itself, for every data cube it knows and for every branch of those data cubes. It reflects what the query cube has received, not what it has already applied onto the cube.



## OpenAPI

````yaml engine/rest/6.2.3/openapi.json GET /activeviam/distribution-observability/rest/v1/{queryCubeName}/state
openapi: 3.1.0
info:
  title: Atoti REST services
  version: 6.2.3-SNAPSHOT
servers:
  - description: The Atoti Server instance to query, over HTTPS
    url: https://{host}
    variables:
      host:
        default: my-atoti-server:9090
        description: Host and port of your Atoti Server instance
  - description: The Atoti Server instance to query, over plain HTTP
    url: http://{host}
    variables:
      host:
        default: my-atoti-server:9090
        description: Host and port of your Atoti Server instance
security: []
tags:
  - description: Implementation of the REST API controller for an ActivePivot database.
    name: Database REST API
  - description: >
      GetAggregatesQuery (GAQ) REST API for executing OLAP queries.


      This API provides a programmatic way to execute GetAggregatesQuery
      operations

      against Atoti cubes. Results are returned in Apache Arrow format for
      efficient

      data transfer and processing.


      **Note:** This API is experimental and may change in future versions
      without notice.
    name: GAQ Query REST API
  - description: >
      XML for Analysis (XMLA) endpoint for executing MDX queries and OLAP
      discovery operations.


      This endpoint implements the XMLA protocol which is used by:

      - Microsoft Excel and other OLAP clients

      - Custom BI tools that support XMLA connectivity


      The endpoint supports both text XML and binary XML formats for improved
      performance.
    name: XMLA API
  - description: Definition of REST API to query data from ActivePivot (V10).
    name: Query REST API (V10)
  - description: Definition of REST API to query data from ActivePivot (V9).
    name: Query REST API (V9)
  - description: Implementation of the REST Bulk API of the content server (version 8).
    name: Bulk REST API
  - description: Implementation of the REST API of the content server.
    name: Content Server REST API
  - description: Implementation of the REST API controller for an ActivePivot database.
    name: Database REST API v9
  - description: ' Definition of the REST service returning the list of services exposed by an application.'
    name: Version REST API
  - description: Rest Service providing the discovery information.
    name: Discovery REST API
  - description: >-
      Endpoints for Atoti Auto-Explain, which explains how a measure varies
      between two members by attributing the variation to the hierarchies that
      drive it.
    name: Auto-Explain
  - description: JSON Web Token (JWT) endpoint.
    name: JWT API
  - description: >
      Endpoints to retrieve and manage query history.


      **Note:** This API is experimental and may change in future versions
      without notice.
    name: Query History REST API (Experimental)
  - description: Description of REST API to configure an ActivePivot application.
    name: Configuration REST API
  - description: API to export the result of MDX queries
    name: Data Export
  - description: >
      GetAggregatesQuery (GAQ) REST API for executing OLAP queries.


      This API provides a programmatic way to execute GetAggregatesQuery
      operations

      against Atoti cubes. Results and updates are streamed in Apache Arrow
      format for efficient

      data transfer and processing.
    name: Continuous GAQ Query REST API
  - description: Endpoints for inspecting the distribution layer of a query cube.
    name: Distribution Observability
  - description: Endpoints of the Atoti BI adapter.
    name: BI Adapter REST API
  - description: Endpoints for AI-based optimization of Atoti cubes
    name: AI Optimizer
  - description: Implementation of the REST Bulk API of the content server.
    name: Bulk REST API
paths:
  /activeviam/distribution-observability/rest/v1/{queryCubeName}/state:
    get:
      tags:
        - Distribution Observability
      summary: Get the distribution state
      description: >-
        Returns the distribution state of the given query cube, as the messages
        received from its data cubes and the JGroups membership notifications
        left it. The state is reported for the query cube itself, for every data
        cube it knows and for every branch of those data cubes. It reflects what
        the query cube has received, not what it has already applied onto the
        cube.
      operationId: getDistributionState
      parameters:
        - description: Name of the query cube whose state is inspected.
          in: path
          name: queryCubeName
          required: true
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryCubeNodeDescription'
                additionalProperties:
                  default: ''
                default: ''
          description: State returned successfully.
        '404':
          content:
            application/json:
              schema:
                additionalProperties:
                  default: ''
                default: ''
                type: string
          description: No such query cube, or distribution is not started on it.
components:
  schemas:
    QueryCubeNodeDescription:
      properties:
        dataCubes:
          additionalProperties:
            $ref: '#/components/schemas/DataCubeNodeDescription'
          type: object
        queryCube:
          $ref: '#/components/schemas/QueryCubeDescription'
      type: object
    DataCubeNodeDescription:
      properties:
        branches:
          additionalProperties:
            $ref: '#/components/schemas/BranchDescription'
          type: object
        dataCube:
          $ref: '#/components/schemas/DataCubeDescription'
      type: object
    QueryCubeDescription:
      properties:
        discoveredApplications:
          items:
            type: string
          type: array
          uniqueItems: true
        retainedActions:
          items:
            $ref: '#/components/schemas/DistributedActionDescription'
          type: array
        state:
          enum:
            - AWAITING_DISCOVERY
            - READY
          type: string
        undiscoveredApplications:
          items:
            type: string
          type: array
          uniqueItems: true
      type: object
    BranchDescription:
      properties:
        failure:
          properties:
            cause:
              properties:
                localizedMessage:
                  type: string
                message:
                  type: string
                stackTrace:
                  items:
                    properties:
                      classLoaderName:
                        type: string
                      className:
                        type: string
                      fileName:
                        type: string
                      lineNumber:
                        format: int32
                        type: integer
                      methodName:
                        type: string
                      moduleName:
                        type: string
                      moduleVersion:
                        type: string
                      nativeMethod:
                        type: boolean
                    type: object
                  type: array
                suppressed:
                  items:
                    properties:
                      localizedMessage:
                        type: string
                      message:
                        type: string
                      stackTrace:
                        items:
                          properties:
                            classLoaderName:
                              type: string
                            className:
                              type: string
                            fileName:
                              type: string
                            lineNumber:
                              format: int32
                              type: integer
                            methodName:
                              type: string
                            moduleName:
                              type: string
                            moduleVersion:
                              type: string
                            nativeMethod:
                              type: boolean
                          type: object
                        type: array
                    type: object
                  type: array
              type: object
            localizedMessage:
              type: string
            message:
              type: string
            stackTrace:
              items:
                properties:
                  classLoaderName:
                    type: string
                  className:
                    type: string
                  fileName:
                    type: string
                  lineNumber:
                    format: int32
                    type: integer
                  methodName:
                    type: string
                  moduleName:
                    type: string
                  moduleVersion:
                    type: string
                  nativeMethod:
                    type: boolean
                type: object
              type: array
            suppressed:
              items:
                properties:
                  localizedMessage:
                    type: string
                  message:
                    type: string
                  stackTrace:
                    items:
                      properties:
                        classLoaderName:
                          type: string
                        className:
                          type: string
                        fileName:
                          type: string
                        lineNumber:
                          format: int32
                          type: integer
                        methodName:
                          type: string
                        moduleName:
                          type: string
                        moduleVersion:
                          type: string
                        nativeMethod:
                          type: boolean
                      type: object
                    type: array
                type: object
              type: array
          type: object
        lastProcessableEpoch:
          format: int64
          type: integer
        lastProcessableSequenceNumber:
          format: int64
          type: integer
        state:
          enum:
            - BROKEN
            - DELETED
            - LIVE
            - PENDING_CREATION
          type: string
      type: object
    DataCubeDescription:
      properties:
        failure:
          properties:
            cause:
              properties:
                localizedMessage:
                  type: string
                message:
                  type: string
                stackTrace:
                  items:
                    properties:
                      classLoaderName:
                        type: string
                      className:
                        type: string
                      fileName:
                        type: string
                      lineNumber:
                        format: int32
                        type: integer
                      methodName:
                        type: string
                      moduleName:
                        type: string
                      moduleVersion:
                        type: string
                      nativeMethod:
                        type: boolean
                    type: object
                  type: array
                suppressed:
                  items:
                    properties:
                      localizedMessage:
                        type: string
                      message:
                        type: string
                      stackTrace:
                        items:
                          properties:
                            classLoaderName:
                              type: string
                            className:
                              type: string
                            fileName:
                              type: string
                            lineNumber:
                              format: int32
                              type: integer
                            methodName:
                              type: string
                            moduleName:
                              type: string
                            moduleVersion:
                              type: string
                            nativeMethod:
                              type: boolean
                          type: object
                        type: array
                    type: object
                  type: array
              type: object
            localizedMessage:
              type: string
            message:
              type: string
            stackTrace:
              items:
                properties:
                  classLoaderName:
                    type: string
                  className:
                    type: string
                  fileName:
                    type: string
                  lineNumber:
                    format: int32
                    type: integer
                  methodName:
                    type: string
                  moduleName:
                    type: string
                  moduleVersion:
                    type: string
                  nativeMethod:
                    type: boolean
                type: object
              type: array
            suppressed:
              items:
                properties:
                  localizedMessage:
                    type: string
                  message:
                    type: string
                  stackTrace:
                    items:
                      properties:
                        classLoaderName:
                          type: string
                        className:
                          type: string
                        fileName:
                          type: string
                        lineNumber:
                          format: int32
                          type: integer
                        methodName:
                          type: string
                        moduleName:
                          type: string
                        moduleVersion:
                          type: string
                        nativeMethod:
                          type: boolean
                      type: object
                    type: array
                type: object
              type: array
          type: object
        lastHelloSequenceNumber:
          format: int64
          type: integer
        lastHelloViewId:
          format: int64
          type: integer
        membershipRegistered:
          type: boolean
        pendingDiscoveryAgeSeconds:
          format: int64
          type: integer
        reservationExpired:
          type: boolean
        state:
          enum:
            - AWAITING_DISCOVERY
            - AWAITING_HELLO
            - BROKEN
            - LIVE
            - PENDING_REMOVAL
            - REMOVED
          type: string
      type: object
    DistributedActionDescription:
      properties:
        action:
          type: string
        description:
          type: string
      type: object

````