Cloudera Docs

Heatmap API

There are two Heatmap APIs available - readaccess and healthCheck. Both the APIs can be called through cURL, Postman, or any API application. Recon UI makes the calls internally when you access the Heatmap page and on the SOLR health check notification in the Overview page.

You can call the API from the cluster endpoint for Recon <Recon Service Host>:<Port>/api/v1/heatmap/* to retrieve the raw data or response using the tools like cURL, Postman, and so on.

GET /heatmap/readaccess

Parameters:
  • path: Path of the entity from the volume level
  • entityType: Type of entity to get the data for
    • Default Value: key
    • Allowed values: key, bucket, or volume
  • startDate: Start date from which to fetch the data. Maximum is 90 days.
    • Default Value: 24H
    • Allowed values: 24H, 7D, 90D, or Unix Timestamp of specific date

Description: Returns the read access count for the entities from the provided filters passed as query arguments.

Returns:

    {
    "label": "root",
    "children": [
    {
    "label": "samplevol",
    "children": [
    {
    "label": "samplebucket1",
    "children": [
    {
    "label": "samplekey1",
    "size": 256,
    "accessCount": 84,
    "color": 1
    },
    {
    "label": "samplekey6",
    "size": 256,
    "accessCount": 32,
    "color": 0.38
    }
    ],
    "size": 13824,
    "path": "/samplevol/samplebucket1",
    "minAccessCount": 32,
    "maxAccessCount": 84
    },
    {
    "label": "samplebucket2",
    "children": [
    {
    "label": "samplekey1",
    "size": 256,
    "accessCount": 65,
    "color": 1
    }
    ],
    "size": 512,
    "path": "/samplevol/samplebucket2",
    "minAccessCount": 41,
    "maxAccessCount": 65
    }
    ],
    "size": 14336,
    "path": "/samplevol/"
    },
    {
    "label": "samplevol1",
    "children": [
    {
    "label": "fso-bucket",
    "children": [
    {
    "label": ".trash",
    "size": 256,
    "accessCount": 24,
    "color": 1
    },
    {
    "label": ".trash/om",
    "size": 256,
    "accessCount": 24,
    "color": 1
    }
    ],
    "size": 512,
    "path": "/samplevol1/fso-bucket",
    "minAccessCount": 24,
    "maxAccessCount": 24
    }
    ],
    "size": 512,
    "path": "/samplevol1/"
    }
    ],
    "size": 14336,
    "minAccessCount": 32,
    "maxAccessCount": 84
    }

GET /heatmap/healthCheck

PARAMETERS: None

Description: Gives the health status of the SOLR service that is running on the cluster.