Get Commcell Health Overview

This API returns number of tiles that are in Critical or Warning state in the Health Report.

Query Parameters

• parameter.commUniId integer required

  Commcell Unique ID. For a single Commcell Environment this value is 10000 else get the value from Get MetricCommUniqId API

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• cacheId string

  Report dataset cache Id

• offset integer

  Denotes the starting point or index from which the requested data begins

• limit integer

  Total number of records in the response

• totalRecordCount integer

  Total Records in the response

• columns object[]

  List of columns in the dataset

  name string

  Column Name

  dataField string

  Data field name

  displayName string

  Display Name of the column

  type string

  Data type

  precision integer

  Decimal point precision

  scale integer
• recordsCount integer

  Total Records in the rows

• records string[]

  Rows containing the output

• failures object
• warnings object

{
  "cacheId": "string",
  "offset": 0,
  "limit": 0,
  "totalRecordCount": 0,
  "columns": [
    {
      "name": "string",
      "dataField": "string",
      "displayName": "string",
      "type": "string",
      "precision": 0,
      "scale": 0
    }
  ],
  "recordsCount": 0,
  "records": [
    "string"
  ],
  "failures": {},
  "warnings": {}
}

{
  "cacheId": "46656c2417264cb5bb6e3eca4963a726",
  "offset": 0,
  "limit": 0,
  "totalRecordCount": 4,
  "columns": [
    {
      "name": "Data Source",
      "dataField": "Data Source",
      "type": "String",
      "precision": 1000000000,
      "scale": 0
    },
    {
      "name": "Status",
      "dataField": "Status",
      "type": "String",
      "precision": 1000000000,
      "scale": 0
    },
    {
      "name": "Count",
      "dataField": "Count",
      "type": "Integer",
      "precision": 32,
      "scale": 0
    }
  ],
  "recordsCount": 4,
  "records": [
    [
      "bdcsrvtest05.testlab.commvault.com",
      "1_Good",
      6
    ],
    [
      "bdcsrvtest05.testlab.commvault.com",
      "2_Info",
      8
    ],
    [
      "bdcsrvtest05.testlab.commvault.com",
      "3_Warning",
      5
    ],
    [
      "bdcsrvtest05.testlab.commvault.com",
      "4_Critical",
      9
    ]
  ],
  "failures": {},
  "warnings": {}
}

Loading...