/2016-07/deployments/:id/scalings

Get scaling information about your deployment

Will respond with the deployment's Scaling information.

Key

Description

allocated_units

The number of units the deployment has available

used_units

The number of units the deployment is actually using

starting_units

The minimum required units for the deployment type

minimum_units

The minimum number of units you can scale to. Equals the greater of used_units or starting_units.

memory_per_unit_in_mb

The amount of memory in megabytes of a single unit. When multiplied by a number of units will equal a total amount of memory (RAM).

storage_per_unit_in_mb

The amount of storage in megabytes of a single unit. When multiplied by a number of units will equal a total amount of storage (disk).

unit_size_in_mb

The size in megabytes of a single unit. Equivalent to memory_per_unit_in_mb when unit_type is memory, or storage_per_unit_in_mb when unit_type is data. Mainly useful for implementing scaling UIs; see note below.

unit_type

The type of unit. Either memory (RAM) or data (disk storage). Mainly useful for implementing scaling UIs; see note below.

Note: The unit_size_in_mb and unit_type fields are hints for applications presenting Scaling UIs on how to present higher and lower scalings in a slider or some other interactive element. This hint is reflected in the Compose UI, for example, where data type slider values rise more rapidly, and to higher values, than memory type slider values. These fields are only of interest to developers implementing consoles that replicate Compose functionality.

For all other uses, use memory_per_unit_in_mb and storage_per_unit_in_mb to determine your deployment's memory and storage allocation, usage, starting value, and minimum.

Language
Authentication
Header
Click Try It! to start a request and see the response here!