Get Metrics for a LoadBalancer

v1.0.0

You must specify the type of metric to get: open_connections, connections_per_second, requests_per_second or bandwidth. You can also specify more than one type by comma separation, e.g. requests_per_second,bandwidth.

Depending on the type you will get different time series data:

Type	Timeseries	Unit	Description
open_connections	open_connections	number	Open connections
connections_per_second	connections_per_second	connections/s	Connections per second
requests_per_second	requests_per_second	requests/s	Requests per second
bandwidth	bandwidth.in	bytes/s	Ingress bandwidth
	bandwidth.out	bytes/s	Egress bandwidth

Metrics are available for the last 30 days only.

If you do not provide the step argument we will automatically adjust it so that 200 samples are returned.

We limit the number of samples to a maximum of 500 and will adjust the step parameter accordingly.

Input

{
  "type": "object",
  "properties": {
    "end": {
      "type": "string"
    },
    "id": {
      "type": "integer"
    },
    "start": {
      "type": "string"
    },
    "step": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "open_connections",
        "connections_per_second",
        "requests_per_second",
        "bandwidth"
      ]
    }
  },
  "required": [
    "end",
    "id",
    "start",
    "type"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "metrics"
  ],
  "properties": {
    "metrics": {
      "type": "object",
      "required": [
        "end",
        "start",
        "step",
        "time_series"
      ],
      "properties": {
        "end": {
          "type": "string",
          "description": "End of period of metrics reported (in ISO-8601 format)"
        },
        "start": {
          "type": "string",
          "description": "Start of period of metrics reported (in ISO-8601 format)"
        },
        "step": {
          "type": "number",
          "description": "Resolution of results in seconds."
        },
        "time_series": {
          "type": "object",
          "description": "Hash with timeseries information, containing the name of timeseries as key"
        }
      }
    }
  }
}