Monitoring Web Services

Overview

Universal Controller supports the following RESTful-based web service for Monitoring operations:

Formatting specifications for each web service, including details about parameter requirements, are provided.

Universal Controller Metrics (Prometheus)

The Universal Controller Metrics API requires the ops_admin role or the ops_service role.


Description

URI

http://host_name/uc/resources/metrics

HTTP Method

GET

Description

Scrape the Universal Controller metrics as Prometheus text.

Example URI

http://localhost:8080/uc/resources/metrics

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

text/plain; version=0.0.4

Example Responses

  • Status 200

    • <Metrics as text/plain; version=0.0.4>

  • Status 403

    • Operation prohibited due to security constraints.