Skip to content

Latest commit

 

History

History
67 lines (41 loc) · 1.68 KB

MetricsApi.md

File metadata and controls

67 lines (41 loc) · 1.68 KB
Raw

.MetricsApi

All URIs are relative to http://127.0.0.1:4646/v1

Method HTTP request Description
getMetricsSummary GET /metrics

getMetricsSummary

MetricsSummary getMetricsSummary()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .MetricsApi(configuration);

let body:.MetricsApiGetMetricsSummaryRequest = {
  // string | The format the user requested for the metrics summary (e.g. prometheus) (optional)
  format: "format_example",
};

apiInstance.getMetricsSummary(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
format [string] The format the user requested for the metrics summary (e.g. prometheus) (optional) defaults to undefined

Return type

MetricsSummary

Authorization

X-Nomad-Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -
400 Bad request -
403 Forbidden -
405 Method not allowed -
500 Internal server error -

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