Autoscaling Groups
Autoscaling groups automatically adjust the number of Instances based on metrics like CPU or memory usage. This allows you to automatically scale your infrastructure up or down to meet demand while optimizing costs.
List autoscaling groups
List all autoscaling groups in a project.
path Parameters
zoneThe zone you want to target
query Parameters
project_idProject ID to filter groups.
order_byOrder criteria for listing groups.
page_sizePage size for pagination.
page_tokenToken for pagination.
template_idTemplate ID to filter groups.
load_balancer_idLoad balancer ID to filter groups.
List autoscaling groups › Responses
List of group summaries.
next_page_tokenToken for the next page of results.
total_countTotal number of groups.
Create an autoscaling group
Create a new autoscaling group with the specified configuration including template, scaling policy, and optional load balancer settings.
path Parameters
zoneThe zone you want to target
Create an autoscaling group › Request Body
project_idProject ID to create the group in.
nameName of the autoscaling group.
tagsTags associated with the group.
template_idTemplate ID for instances in this group.
Scaling policy configuration.
Optional load balancer configuration.
Create an autoscaling group › Responses
idUnique identifier of the autoscaling group.
project_idProject ID owning this group.
nameName of the autoscaling group.
tagsTags associated with the group.
created_atCreation timestamp of the group. (RFC 3339 format)
updated_atLast update timestamp of the group. (RFC 3339 format)
statusCurrent status of the autoscaling group.
List of active alerts on the group.
current_sizeCurrent number of instances in the group.
target_sizeTarget number of instances the group is scaling to.
last_scale_out_atTimestamp of the last scale out event. (RFC 3339 format)
last_scale_in_atTimestamp of the last scale in event. (RFC 3339 format)
template_idThe Instance template ID used to create instances in this group.
Scaling policy configuration.
Optional load balancer configuration.
Get an autoscaling group
Get details of a specified autoscaling group including its configuration, current size, and status.
path Parameters
zoneThe zone you want to target
group_idID of the group to get.
Get an autoscaling group › Responses
idUnique identifier of the autoscaling group.
project_idProject ID owning this group.
nameName of the autoscaling group.
tagsTags associated with the group.
created_atCreation timestamp of the group. (RFC 3339 format)
updated_atLast update timestamp of the group. (RFC 3339 format)
statusCurrent status of the autoscaling group.
List of active alerts on the group.
current_sizeCurrent number of instances in the group.
target_sizeTarget number of instances the group is scaling to.
last_scale_out_atTimestamp of the last scale out event. (RFC 3339 format)
last_scale_in_atTimestamp of the last scale in event. (RFC 3339 format)
template_idThe Instance template ID used to create instances in this group.
Scaling policy configuration.
Optional load balancer configuration.
Delete an autoscaling group
Delete a specified autoscaling group and all its associated resources.
path Parameters
zoneThe zone you want to target
group_idID of the group to delete.
Delete an autoscaling group › Responses
idUnique identifier of the autoscaling group.
project_idProject ID owning this group.
nameName of the autoscaling group.
tagsTags associated with the group.
created_atCreation timestamp of the group. (RFC 3339 format)
updated_atLast update timestamp of the group. (RFC 3339 format)
statusCurrent status of the autoscaling group.
List of active alerts on the group.
current_sizeCurrent number of instances in the group.
target_sizeTarget number of instances the group is scaling to.
last_scale_out_atTimestamp of the last scale out event. (RFC 3339 format)
last_scale_in_atTimestamp of the last scale in event. (RFC 3339 format)
template_idThe Instance template ID used to create instances in this group.
Scaling policy configuration.
Optional load balancer configuration.
Update an autoscaling group
Update the configuration of a specified autoscaling group including name, tags, template, scaling policy, and load balancer settings.
path Parameters
zoneThe zone you want to target
group_idID of the group to update.
Update an autoscaling group › Request Body
nameNew name for the group.
tagsNew tags for the group.
template_idNew template ID for instances.
New scaling policy configuration.
New load balancer configuration.
Update an autoscaling group › Responses
idUnique identifier of the autoscaling group.
project_idProject ID owning this group.
nameName of the autoscaling group.
tagsTags associated with the group.
created_atCreation timestamp of the group. (RFC 3339 format)
updated_atLast update timestamp of the group. (RFC 3339 format)
statusCurrent status of the autoscaling group.
List of active alerts on the group.
current_sizeCurrent number of instances in the group.
target_sizeTarget number of instances the group is scaling to.
last_scale_out_atTimestamp of the last scale out event. (RFC 3339 format)
last_scale_in_atTimestamp of the last scale in event. (RFC 3339 format)
template_idThe Instance template ID used to create instances in this group.
Scaling policy configuration.
Optional load balancer configuration.