Autoscale

API Reference

GPU Droplets

Autoscale

Autoscale

Create a New Autoscale Pool

gpu_droplets.autoscale.create(AutoscaleCreateParams**kwargs) -> autoscale_poolAutoscalePoolAutoscaleCreateResponse

post/v2/droplets/autoscale

Delete autoscale pool

gpu_droplets.autoscale.delete(strautoscale_pool_id)

delete/v2/droplets/autoscale/{autoscale_pool_id}

Delete autoscale pool and resources

gpu_droplets.autoscale.delete_dangerous(strautoscale_pool_id, AutoscaleDeleteDangerousParams**kwargs)

delete/v2/droplets/autoscale/{autoscale_pool_id}/dangerous

List All Autoscale Pools

gpu_droplets.autoscale.list(AutoscaleListParams**kwargs) -> metaMetaPropertiesautoscale_poolslistlinksPageLinksAutoscaleListResponse

get/v2/droplets/autoscale

List history events

gpu_droplets.autoscale.list_history(strautoscale_pool_id, AutoscaleListHistoryParams**kwargs) -> metaMetaPropertieshistorylistlinksPageLinksAutoscaleListHistoryResponse

get/v2/droplets/autoscale/{autoscale_pool_id}/history

List members

gpu_droplets.autoscale.list_members(strautoscale_pool_id, AutoscaleListMembersParams**kwargs) -> metaMetaPropertiesdropletslistlinksPageLinksAutoscaleListMembersResponse

get/v2/droplets/autoscale/{autoscale_pool_id}/members

Retrieve an Existing Autoscale Pool

gpu_droplets.autoscale.retrieve(strautoscale_pool_id) -> autoscale_poolAutoscalePoolAutoscaleRetrieveResponse

get/v2/droplets/autoscale/{autoscale_pool_id}

Update Autoscale Pool

gpu_droplets.autoscale.update(strautoscale_pool_id, AutoscaleUpdateParams**kwargs) -> autoscale_poolAutoscalePoolAutoscaleUpdateResponse

put/v2/droplets/autoscale/{autoscale_pool_id}

Autoscale Pool

AutoscalePoolclass

ShowShow

idstr

A unique identifier for each autoscale pool instance. This is automatically generated upon autoscale pool creation.

active_resources_countint

The number of active Droplets in the autoscale pool.

configConfig

The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration).

Hide ParametersShow Parameters

target_number_instancesintAutoscalePoolStaticConfig

max_instancesintmin_instancesintcooldown_minutesinttarget_cpu_utilizationfloattarget_memory_utilizationfloatAutoscalePoolDynamicConfig

created_atdatetime

A time value given in ISO8601 combined date and time format that represents when the autoscale pool was created.

formatdate-time

droplet_templateimagestrregionliteralsizestrssh_keyslistipv6boolnamestrproject_idstrtagslistuser_datastrvpc_uuidstrwith_droplet_agentboolAutoscalePoolDropletTemplate

namestr

The human-readable name set for the autoscale pool.

statusliteral

Literal["active", "deleting", "error"]

The current status of the autoscale pool.

Hide ParametersShow Parameters

"active"

"deleting"

"error"

updated_atdatetime

A time value given in ISO8601 combined date and time format that represents when the autoscale pool was last updated.

formatdate-time

current_utilizationCurrentUtilization

optional

Autoscale Pool Droplet Template

AutoscalePoolDropletTemplateclass

ShowShow

imagestr

The Droplet image to be used for all Droplets in the autoscale pool. You may specify the slug or the image ID.

regionliteral

Literal["nyc1", "nyc2", "nyc3", 11 more]

The datacenter in which all of the Droplets will be created.

Hide ParametersShow Parameters

"nyc1"

"nyc2"

"nyc3"

"ams2"

"ams3"

"sfo1"

"sfo2"

"sfo3"

"sgp1"

"lon1"

"fra1"

"tor1"

"blr1"

"syd1"

sizestr

The Droplet size to be used for all Droplets in the autoscale pool.

ssh_keyslist

List[str]

The SSH keys to be installed on the Droplets in the autoscale pool. You can either specify the key ID or the fingerprint. Requires ssh_key:read scope.

ipv6bool

optional

Assigns a unique IPv6 address to each of the Droplets in the autoscale pool.

namestr

optional

The name(s) to be applied to all Droplets in the autoscale pool.

project_idstr

optional

The project that the Droplets in the autoscale pool will belong to. Requires project:read scope.

tagslist

optional

Optional[List[str]]

The tags to apply to each of the Droplets in the autoscale pool. Requires tag:read scope.

user_datastr

optional

A string containing user data that cloud-init consumes to configure a Droplet on first boot. User data is often a cloud-config file or Bash script. It must be plain text and may not exceed 64 KiB in size.

vpc_uuidstr

optional

The VPC where the Droplets in the autoscale pool will be created. The VPC must be in the region where you want to create the Droplets. Requires vpc:read scope.

with_droplet_agentbool

optional

Installs the Droplet agent. This must be set to true to monitor Droplets for resource utilization scaling.

Autoscale Pool Dynamic Config

AutoscalePoolDynamicConfigclass

ShowShow

max_instancesint

The maximum number of Droplets in an autoscale pool.

minimum1

maximum1000

min_instancesint

The minimum number of Droplets in an autoscale pool.

minimum1

maximum500

cooldown_minutesint

optional

The number of minutes to wait between scaling events in an autoscale pool. Defaults to 10 minutes.

minimum5

maximum20

target_cpu_utilizationfloat

optional

Target CPU utilization as a decimal.

formatfloat

minimum0.05

maximum1

target_memory_utilizationfloat

optional

Target memory utilization as a decimal.

formatfloat

minimum0.05

maximum1

Autoscale Pool Static Config

AutoscalePoolStaticConfigclass

ShowShow

target_number_instancesint

Fixed number of instances in an autoscale pool.

minimum1

maximum1000

Current Utilization

CurrentUtilizationclass

ShowShow

cpufloat

optional

The average CPU utilization of the autoscale pool.

formatfloat

minimum0

maximum1

memoryfloat

optional

The average memory utilization of the autoscale pool.

formatfloat

minimum0

maximum1