ScalingMetric object

Example JSON representation

{
  "filePath": "string", 
  "function": "average", 
  "inverted": true, 
  "name": "string", 
  "retrieveMethod": "read", 
  "scope": "scalr"
}

Properties

property attributes valid values description filter option
filePath
string
required

Path to the File

function
string
required
filterable
"average"
"sum"
"min"
"max"

Aggregate function to use when executing decision logic.

?function=...
name
string
required
filterable

The name of a Scaling Metric.

?name=...
retrieveMethod
string
required
filterable
"read"
"execute"
"url-request"

The operation that should be performed on the File to obtain the value of the Metric.

?retrieveMethod=...
scope
string
read-only
filterable
"scalr"
"account"
"environment"
"farm"
"farmrole"
"role"
"server"
?scope=...
inverted
boolean
optional
filterable

Whether this metric should be inverted. By default Farm Roles scale up when the value goes above the scale up threshold. If this is true, Farm Roles will scale up when the value goes below the scale up threshold.

?inverted=...

Endpoints using this object