Get System Metrics Info

Gets the system metrics of all the components.

Request

URI

GET

https://{api_host}/rest/monitor/v1/system-metrics

COPY

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns SystemMetricsInfo of type(s) */*

{
    "event_error_count": 3,
    "event_warning_count": 6,
    "health_metrics_info": {
        "component": "ALL",
        "error_count": 3,
        "healthy_count": 5,
        "total_count": 13,
        "unknown_count": 2,
        "warning_count": 3
    },
    "problem_rds_hosts_count": 3,
    "problem_vcenter_vms_count": 2,
    "sessions_count": 6
}

integer As int32 As int32

event_error_count

Optional

Number of events with the "Error" severity.

integer As int32 As int32

event_warning_count

Optional

Number of events with the "Warn" severity.

HealthMetricsInfo

health_metrics_info

Optional

health_metrics_info

integer As int32 As int32

problem_rds_hosts_count

Optional

Number of RDS Hosts that are part of a farm and which are in any of the following status statesAGENT_UNREACHABLE, AGENT_CONFIG_ERROR, UNKNOWN, ALREADY_USED, PROVISIONING_ERROR, ERROR and AGENT_ERR_PROTOCOL_FAILURE.

integer As int32 As int32

problem_vcenter_vms_count

Optional

Number of the managed VMs which are in any of the following machine's basic_state states AGENT_ERR_DISABLED, AGENT_UNREACHABLE, AGENT_ERR_INVALID_IP, AGENT_ERR_NEED_REBOOT,AGENT_ERR_PROTOCOL_FAILURE, AGENT_ERR_DOMAIN_FAILURE, AGENT_CONFIG_ERROR, PROVISIONING_ERROR, ERROR, UNASSIGNED_USER_CONNECTED,UNASSIGNED_USER_DISCONNECTED, UNKNOWN.

integer As int32 As int32

sessions_count

Optional

Number of active sessions.

401

User is not authenticated

Operation doesn't return any data structure

On This Page

Description

Request

Authentication

Response

200 Response Body

Errors

Monitor Operations