.HealthCollectorApi

All URIs are relative to http://localhost

Method	HTTP request	Description
healthCollectorGetDataWarehouseUsage	GET /api/v3/metrics/warehouse/{type}	Summary: Get data warehouse usage info Description: Get information from data warehouse related to usage
healthCollectorGetGDPHealthInfo	GET /api/v3/health	Summary: Get GDP health info Description: Get information from MongoDB for Guardium central managers using health-connector service.
healthCollectorGetHistoricalHealthInfo	GET /api/v3/health/history	Summary: Get historical health info Description: Retrieve historical s-tap related statistics from health-collector service.
healthCollectorGetObjectStorageUsage	GET /api/v3/metrics/object_storage/{type}	Summary: Get object storage usage info Description: Get information from object storage about tenant bucket usage
healthCollectorGetPVCUsage	GET /api/v3/metrics/pvc/{type}	Summary: Get the PVC usage information Description: Get information about the PVC usage in the OCP cluster
healthCollectorGetPodRestarts	GET /api/v3/metrics/pods/{type}	Summary: Get the pod restart information Description: Get information about the number of restarts by pod in OCP
healthCollectorGetStreamsIngestion	GET /api/v3/metrics/streams/{type}	Summary: Get streams ingestion volume over a given time Description: Get information about streams ingestion volume
healthCollectorGetTopGDPCollectors	GET /api/v3/metrics/collectors/{type}	Summary: Get the top GDP collectors which send data to GI Description: Get information about the top GDP collectors
healthCollectorStoreHealthInfo	POST /api/v3/health/central_managers/{central_manager_id}/health_info	Summary: Store health info Description: Store health info from GDP into GI. (This API is called from GDP only)

healthCollectorGetDataWarehouseUsage

Healthcollectorv3GetDataWarehouseUsageResponse healthCollectorGetDataWarehouseUsage()

Example

import { createConfiguration, HealthCollectorApi } from '';
import type { HealthCollectorApiHealthCollectorGetDataWarehouseUsageRequest } from '';

const configuration = createConfiguration();
const apiInstance = new HealthCollectorApi(configuration);

const request: HealthCollectorApiHealthCollectorGetDataWarehouseUsageRequest = {
    // The type of metric to retrieve
  type: "type_example",
    // The start time from which the data needs to be calculated. (optional)
  startTime: new Date('1970-01-01T00:00:00.00Z'),
    // The end time from which the data needs to be calculated. (optional)
  endTime: new Date('1970-01-01T00:00:00.00Z'),
};

const data = await apiInstance.healthCollectorGetDataWarehouseUsage(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
type	[string]	The type of metric to retrieve	defaults to undefined
startTime	[Date]	The start time from which the data needs to be calculated.	(optional) defaults to undefined
endTime	[Date]	The end time from which the data needs to be calculated.	(optional) defaults to undefined

Return type

Healthcollectorv3GetDataWarehouseUsageResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

healthCollectorGetGDPHealthInfo

Healthcollectorv3GetGDPHealthInfoResponse healthCollectorGetGDPHealthInfo()

Example

import { createConfiguration, HealthCollectorApi } from '';

const configuration = createConfiguration();
const apiInstance = new HealthCollectorApi(configuration);

const request = {};

const data = await apiInstance.healthCollectorGetGDPHealthInfo(request);
console.log('API called successfully. Returned data:', data);

Parameters

This endpoint does not need any parameter.

Return type

Healthcollectorv3GetGDPHealthInfoResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

healthCollectorGetHistoricalHealthInfo

Healthcollectorv3GetHistoricalHealthInfoResponse healthCollectorGetHistoricalHealthInfo()

Example

import { createConfiguration, HealthCollectorApi } from '';
import type { HealthCollectorApiHealthCollectorGetHistoricalHealthInfoRequest } from '';

const configuration = createConfiguration();
const apiInstance = new HealthCollectorApi(configuration);

const request: HealthCollectorApiHealthCollectorGetHistoricalHealthInfoRequest = {
    // Type of unit for which data needs to be retrieved. (optional)
  unit: "UNKNOWN_UNIT",
    // Optional value if the data is for a particular cm. If it is empty the data for all cms would be retrieved. (optional)
  cmId: "cm_id_example",
    // The start time from which the data needs to be calculated. (optional)
  startTime: new Date('1970-01-01T00:00:00.00Z'),
    // The end time from which the data needs to be calculated. (optional)
  endTime: new Date('1970-01-01T00:00:00.00Z'),
};

const data = await apiInstance.healthCollectorGetHistoricalHealthInfo(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
unit	[**'UNKNOWN_UNIT'	'STAP']Array<'UNKNOWN_UNIT' \| 'STAP'>**	Type of unit for which data needs to be retrieved.
cmId	[string]	Optional value if the data is for a particular cm. If it is empty the data for all cms would be retrieved.	(optional) defaults to undefined
startTime	[Date]	The start time from which the data needs to be calculated.	(optional) defaults to undefined
endTime	[Date]	The end time from which the data needs to be calculated.	(optional) defaults to undefined

Return type

Healthcollectorv3GetHistoricalHealthInfoResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

healthCollectorGetObjectStorageUsage

Healthcollectorv3GetObjectStorageUsageResponse healthCollectorGetObjectStorageUsage()

Example

import { createConfiguration, HealthCollectorApi } from '';
import type { HealthCollectorApiHealthCollectorGetObjectStorageUsageRequest } from '';

const configuration = createConfiguration();
const apiInstance = new HealthCollectorApi(configuration);

const request: HealthCollectorApiHealthCollectorGetObjectStorageUsageRequest = {
    // The type of metric to retrieve
  type: "type_example",
    // The start time from which the data needs to be calculated. (optional)
  startTime: new Date('1970-01-01T00:00:00.00Z'),
    // The end time from which the data needs to be calculated. (optional)
  endTime: new Date('1970-01-01T00:00:00.00Z'),
};

const data = await apiInstance.healthCollectorGetObjectStorageUsage(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
type	[string]	The type of metric to retrieve	defaults to undefined
startTime	[Date]	The start time from which the data needs to be calculated.	(optional) defaults to undefined
endTime	[Date]	The end time from which the data needs to be calculated.	(optional) defaults to undefined

Return type

Healthcollectorv3GetObjectStorageUsageResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

healthCollectorGetPVCUsage

Healthcollectorv3GetPVCUsageResponse healthCollectorGetPVCUsage()

Example

import { createConfiguration, HealthCollectorApi } from '';
import type { HealthCollectorApiHealthCollectorGetPVCUsageRequest } from '';

const configuration = createConfiguration();
const apiInstance = new HealthCollectorApi(configuration);

const request: HealthCollectorApiHealthCollectorGetPVCUsageRequest = {
    // The type of metric to retrieve
  type: "type_example",
    // The start time from which the data needs to be calculated. (optional)
  startTime: new Date('1970-01-01T00:00:00.00Z'),
    // The end time from which the data needs to be calculated. (optional)
  endTime: new Date('1970-01-01T00:00:00.00Z'),
};

const data = await apiInstance.healthCollectorGetPVCUsage(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
type	[string]	The type of metric to retrieve	defaults to undefined
startTime	[Date]	The start time from which the data needs to be calculated.	(optional) defaults to undefined
endTime	[Date]	The end time from which the data needs to be calculated.	(optional) defaults to undefined

Return type

Healthcollectorv3GetPVCUsageResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

healthCollectorGetPodRestarts

Healthcollectorv3GetPodRestartsResponse healthCollectorGetPodRestarts()

Example

import { createConfiguration, HealthCollectorApi } from '';
import type { HealthCollectorApiHealthCollectorGetPodRestartsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new HealthCollectorApi(configuration);

const request: HealthCollectorApiHealthCollectorGetPodRestartsRequest = {
    // The type of metric to retrieve
  type: "type_example",
    // The start time from which the data needs to be calculated. (optional)
  startTime: new Date('1970-01-01T00:00:00.00Z'),
    // The end time from which the data needs to be calculated. (optional)
  endTime: new Date('1970-01-01T00:00:00.00Z'),
};

const data = await apiInstance.healthCollectorGetPodRestarts(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
type	[string]	The type of metric to retrieve	defaults to undefined
startTime	[Date]	The start time from which the data needs to be calculated.	(optional) defaults to undefined
endTime	[Date]	The end time from which the data needs to be calculated.	(optional) defaults to undefined

Return type

Healthcollectorv3GetPodRestartsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

healthCollectorGetStreamsIngestion

Healthcollectorv3GetStreamsIngestionResponse healthCollectorGetStreamsIngestion()

Example

import { createConfiguration, HealthCollectorApi } from '';
import type { HealthCollectorApiHealthCollectorGetStreamsIngestionRequest } from '';

const configuration = createConfiguration();
const apiInstance = new HealthCollectorApi(configuration);

const request: HealthCollectorApiHealthCollectorGetStreamsIngestionRequest = {
    // The type of metric to retrieve
  type: "type_example",
    // The start time from which the data needs to be calculated. (optional)
  startTime: new Date('1970-01-01T00:00:00.00Z'),
    // The end time from which the data needs to be calculated. (optional)
  endTime: new Date('1970-01-01T00:00:00.00Z'),
};

const data = await apiInstance.healthCollectorGetStreamsIngestion(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
type	[string]	The type of metric to retrieve	defaults to undefined
startTime	[Date]	The start time from which the data needs to be calculated.	(optional) defaults to undefined
endTime	[Date]	The end time from which the data needs to be calculated.	(optional) defaults to undefined

Return type

Healthcollectorv3GetStreamsIngestionResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

healthCollectorGetTopGDPCollectors

Healthcollectorv3GetTopGDPCollectorsResponse healthCollectorGetTopGDPCollectors()

Example

import { createConfiguration, HealthCollectorApi } from '';
import type { HealthCollectorApiHealthCollectorGetTopGDPCollectorsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new HealthCollectorApi(configuration);

const request: HealthCollectorApiHealthCollectorGetTopGDPCollectorsRequest = {
    // The type of metric to retrieve
  type: "type_example",
    // The start time from which the data needs to be calculated. (optional)
  startTime: new Date('1970-01-01T00:00:00.00Z'),
    // The end time from which the data needs to be calculated. (optional)
  endTime: new Date('1970-01-01T00:00:00.00Z'),
};

const data = await apiInstance.healthCollectorGetTopGDPCollectors(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
type	[string]	The type of metric to retrieve	defaults to undefined
startTime	[Date]	The start time from which the data needs to be calculated.	(optional) defaults to undefined
endTime	[Date]	The end time from which the data needs to be calculated.	(optional) defaults to undefined

Return type

Healthcollectorv3GetTopGDPCollectorsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

healthCollectorStoreHealthInfo

Healthcollectorv3StoreHealthInfoResponse healthCollectorStoreHealthInfo(healthcollectorv3StoreHealthInfoRequest)

Example

import { createConfiguration, HealthCollectorApi } from '';
import type { HealthCollectorApiHealthCollectorStoreHealthInfoRequest } from '';

const configuration = createConfiguration();
const apiInstance = new HealthCollectorApi(configuration);

const request: HealthCollectorApiHealthCollectorStoreHealthInfoRequest = {
    // ID of central manager.
  centralManagerId: "central_manager_id_example",
  
  healthcollectorv3StoreHealthInfoRequest: {
    centralManagerId: "centralManagerId_example",
    data: [
      {
        nodes: [
          {
            aggHealthStatus: 1,
            connectivity: 1,
            details: {
              aggHealthViewList: [
                {
                  aggActionError: "aggActionError_example",
                  aggActionHealthStatus: 1,
                  aggType: "aggType_example",
                  errorCode: 1,
                  unit: "unit_example",
                },
              ],
              connectivityDetails: {
                errMessages: "errMessages_example",
              },
              generalErrMessages: [
                "generalErrMessages_example",
              ],
              utilizationScheme: {
                analyzerQueueValue: 1,
                errorMessagesCode: 1,
                errorMessagesValue: "errorMessagesValue_example",
                freeBuffSpaceValue: 1,
                loggerQueueValue: 1,
                mysqlDiskUsageValue: 1,
                noOfRestartsValue: 1,
                numOfExceptionsValue: 1,
                numOfFlatLogRequestsValue: 1,
                numOfPolicyViolationsValue: 1,
                numOfRequestsValue: 1,
                precMysqlMemValue: 1,
                snifMemoryValue: 1,
                sysVarDiskUsageValue: 1,
                systemCpuLoadValue: 1,
              },
            },
            exportsTo: [
              "exportsTo_example",
            ],
            id: 1,
            importsFrom: [
              "importsFrom_example",
            ],
            musStapsHealthStatus: 1,
            name: "name_example",
            osVersion: "osVersion_example",
            patch: "patch_example",
            status: 1,
            type: "type_example",
            unitHostIp: "unitHostIp_example",
            unitUtilizationHealthStatus: 1,
            version: "version_example",
          },
        ],
        staps: [
          {
            children: [
              {
                ieStatus: 1,
                inspectionEngine: "inspectionEngine_example",
              },
            ],
            collectorHostName: "collectorHostName_example",
            connectivity: 1,
            details: {
              connectivityDetails: {
                errMessages: "errMessages_example",
              },
              generalErrMessages: [
                "generalErrMessages_example",
              ],
              ktapDetails: {
                errMessages: "errMessages_example",
              },
              stapLivelinessInfo: {
                hasEvent: true,
                healthStatus: 1,
                livelinessState: "livelinessState_example",
                stap: "stap_example",
              },
              stapVerInfoList: [
                {
                  ie: "ie_example",
                  port: "port_example",
                  protocol: "protocol_example",
                  stap: "stap_example",
                  verificationHealth: 1,
                  verificationResult: "verificationResult_example",
                  verificationState: "verificationState_example",
                  version: "version_example",
                },
              ],
              trafficDetails: {
                errMessages: "errMessages_example",
              },
            },
            ieStatus: 1,
            inspectionEngine: "inspectionEngine_example",
            ktap: 1,
            name: "name_example",
            osType: "osType_example",
            revision: "revision_example",
            stapIp: "stapIp_example",
            status: 1,
            traffic: 1,
          },
        ],
      },
    ],
  },
};

const data = await apiInstance.healthCollectorStoreHealthInfo(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
healthcollectorv3StoreHealthInfoRequest	Healthcollectorv3StoreHealthInfoRequest
centralManagerId	[string]	ID of central manager.	defaults to undefined

Return type

Healthcollectorv3StoreHealthInfoResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

HealthCollectorApi.md

Latest commit

History

HealthCollectorApi.md

File metadata and controls

.HealthCollectorApi

healthCollectorGetDataWarehouseUsage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

healthCollectorGetGDPHealthInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

healthCollectorGetHistoricalHealthInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

healthCollectorGetObjectStorageUsage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

healthCollectorGetPVCUsage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

healthCollectorGetPodRestarts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

healthCollectorGetStreamsIngestion

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

healthCollectorGetTopGDPCollectors

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

healthCollectorStoreHealthInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details