Page tree

Overview

The Get VM Resource Stats API retrieves statistics for your virtual machine. 

You can use the Get VMs to find the virtual machine ID (id).

Sample request

GET https://api.armor.com/stats/vms/1?Interval=5m&StartDate=2015-12-08T00:00:00&EndDate=2015-01-07T23:59:59

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type

/stats/vms/{vmId}?Interval={Interval}&StartDate={startDate}&EndDate={EndDate}

GET


The following table describes the parameter (or parameters) for this API call: 

ParameterDescriptionRequired or optionalTypeExample

vmId

The ID for the virtual machineRequiredInteger1

Interval

The interval of information to display, in minutes

RequiredString5m

startDate

The start date and time, in combined date and time format (ISO 8601)

RequiredDateTime2015-12-08T00:00:00

endDate

The end date and time, in combined date and time format (ISO 8601)RequiredDateTime2015-01-07T23:59:59


To use multiple, optional parameters in one request, you must use the ampersand symbol ( & ) to connect each parameter together.


Sample return

StatusResponse
200
 {
 "vmId": "1",
 "cpu": [
   {
     "t": "2015-03-05T21:00:00",
     "v": 0,
     "s": "cpu"
   }
  ],
 "network": [
   {
     "t": "2015-03-05T21:00:00",
     "v": 0,
     "s": "network"
   }
  ],
 "memory": [
   {
     "t": "2015-03-05T21:00:00",
     "v": 0,
     "s": "memory"
   }
  ]
}
400
Bad Request

 



In this topic



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.