Auto Scaling Data Types

This section describes common data types used in auto-scaling API calls.

Type

autoscale-settings

Syntax

Element	Attribute	Description
`autoscale-rule`		Container for an individual auto scaling rule. This element may appear more than once (one for each rule).
	`enabled`	Not currently used. Type: boolean
	`deleted`	Used for output only. If set to true, it indicates that a request to delete the rule has been received but has not been completed yet. Type: boolean
	`metric`	The type of resource to auto scale. Possible values: "cpu" – CPU "ram" – RAM Type: string
	`version`	Used for output only. Version information. Type: int
	`updated`	Used for output only. The date and time of the last rule update operation. Type: timestamp
	`update-delivered-ok`	Used for output only. Indicates whether the rule update has been processed and delivered to the server. True means the update was completed successfully. False means the update is still in progress (can also indicate failure). Type: boolean
	`update-delivered`	Used for output only. The date and time when the rule update has been delivered to the server. Type: timestamp
	`allow-migration`	Specifies whether to allow migration of the server to a different hardware node. Type: boolean. Default is True.
	`allow-restart`	Specifies whether to allow the server restart if needed. Type: boolean. Default is False.
`limits`		Container for scaling limits.
	`min`	The minimum allowed resource limit. This value is used when a resource is downscaled. Specified in megabytes for RAM and megahertz for CPU. Type: int
	`max`	The maximum allowed resource limit. This value is used when a resource is upscaled. Specified in megabytes for RAM and megahertz for CPU. Type: int
	`step`	An increment or decrement of a resource usage to be performed in a single scaling step. Specified in megabytes for RAM and megahertz for CPU. Type: int
`thresholds`		Container for threshold information.
`up`		Upscaling threshold.
	`thresholds`	Specifies the total load of the resource (percentage). When this value is reached and maintained for the specified period of time (see `period` below), resource upscaling will be performed. Type: int (0–100)
	`period`	Specifies the time period, in seconds, of the threshold state after which resource upscaling will be performed. Type: int
`down`		Downscaling threshold.
	`thresholds`	Specifies the total load of the resource (percentage). When this value is reached and maintained for the specified period of time (see `period` below), resource downscaling will be performed. Type: int (0–100)
	`period`	Specifies the time period, in seconds, of the threshold state after which resource downscaling will be performed. Type: int