Get Metrics for a Server

v1.0.0

Get Metrics for specified Server.

You must specify the type of metric to get: cpu, disk or network. You can also specify more than one type by comma separation, e.g. cpu,disk.

Depending on the type you will get different time series data

Type	Timeseries	Unit	Description
cpu	cpu	percent	Percent CPU usage
disk	disk.0.iops.read	iop/s	Number of read IO operations per second
	disk.0.iops.write	iop/s	Number of write IO operations per second
	disk.0.bandwidth.read	bytes/s	Bytes read per second
	disk.0.bandwidth.write	bytes/s	Bytes written per second
network	network.0.pps.in	packets/s	Public Network interface packets per second received
	network.0.pps.out	packets/s	Public Network interface packets per second sent
	network.0.bandwidth.in	bytes/s	Public Network interface bytes/s received
	network.0.bandwidth.out	bytes/s	Public Network interface bytes/s sent

Metrics are available for the last 30 days only.

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

We limit the number of samples returned 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": [
        "cpu",
        "disk",
        "network"
      ]
    }
  },
  "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"
        }
      }
    }
  }
}