Scaleway logo
Autoscaling Groups API
Autoscaling Groups API

Schemas

Download schema

scaleway.autoscaling.v1alpha2.Alert

Type of alert.

Enum values:
unknown_alert_type
quotas_exceeded
out_of_stock
invalid_template
template_not_found
invalid_instance
template_permissions_denied
load_balancer_not_found
Default: unknown_alert_type
opened_at
​string | null · date-time

Timestamp when the alert was opened. (RFC 3339 format)

closed_at
​string | null · date-time

Optional timestamp when the alert was closed. (RFC 3339 format)

group_id
​string

ID of the group.

failing_quotas
​string[]

List of quota names that are exceeded (for quotas_exceeded alerts).

scaleway.autoscaling.v1alpha2.Alert.AlertType

string · enum
Enum values:
unknown_alert_type
quotas_exceeded
out_of_stock
invalid_template
template_not_found
invalid_instance
template_permissions_denied
load_balancer_not_found
Default: unknown_alert_type

scaleway.autoscaling.v1alpha2.Group

srn
​string · pattern: ^srn://autoscaling\.…

SRN of the Autoscaling Group.

id
​string

Unique identifier of the autoscaling group.

project_id
​string

Project ID owning this group.

name
​string

Name of the autoscaling group.

tags
​string[]

Tags associated with the group.

created_at
​string | null · date-time

Creation timestamp of the group. (RFC 3339 format)

updated_at
​string | null · date-time

Last update timestamp of the group. (RFC 3339 format)

Current status of the autoscaling group.

Enum values:
unknown_group_status
active
scaling_out
scaling_in
refreshing
healing
scaling_failure
deleting
Default: unknown_group_status

List of active alerts on the group.

current_size
​integer · uint32

Current number of instances in the group.

target_size
​integer · uint32

Target number of instances the group is scaling to.

last_scale_out_at
​string | null · date-time

Timestamp of the last scale out event. (RFC 3339 format)

last_scale_in_at
​string | null · date-time

Timestamp of the last scale in event. (RFC 3339 format)

template_id
​string

The Instance template ID used to create instances in this group.

Scaling policy configuration.

Optional load balancer configuration.

zone
​string

Zone of the Autoscaling Group.

scaleway.autoscaling.v1alpha2.Group.GroupStatus

string · enum
Enum values:
unknown_group_status
active
scaling_out
scaling_in
refreshing
healing
scaling_failure
deleting
Default: unknown_group_status

scaleway.autoscaling.v1alpha2.Group.LoadBalancerConfiguration

load_balancer_id
​string

scaleway.autoscaling.v1alpha2.Group.LoadBalancerConfiguration.AutoHealing

enabled
​boolean
grace_period
​string | null

(in seconds)

scaleway.autoscaling.v1alpha2.Group.LoadBalancerConfiguration.Backend

backend_id
​string
Enum values:
unknown_address_family
ipv4
ipv6
Default: unknown_address_family
private_network_id
​string | null

scaleway.autoscaling.v1alpha2.Group.LoadBalancerConfiguration.Backend.AddressFamily

string · enum
Enum values:
unknown_address_family
ipv4
ipv6
Default: unknown_address_family

scaleway.autoscaling.v1alpha2.Group.ScalingPolicy

minimum_size
​integer · uint32
maximum_size
​integer · uint32
scale_out_cooldown
​string | null

(in seconds)

scale_in_cooldown
​string | null

(in seconds)

scale_in_step
​integer · uint32
scale_out_step
​integer · uint32
​
​
​

scaleway.autoscaling.v1alpha2.Group.ScalingPolicy.ScalingPolicyCpuTarget

target_avg_percent
​integer · uint32

scaleway.autoscaling.v1alpha2.Group.ScalingPolicy.ScalingPolicyFixedSize

size
​integer · uint32

scaleway.autoscaling.v1alpha2.Group.ScalingPolicy.ScalingPolicyMemoryTarget

target_avg_percent
​integer · uint32

scaleway.autoscaling.v1alpha2.GroupSummary

srn
​string · pattern: ^srn://autoscaling\.…

SRN of the Autoscaling Group.

project_id
​string

Project ID owning this group.

id
​string

Unique identifier of the autoscaling group.

name
​string

Name of the autoscaling group.

tags
​string[]

Tags associated with the group.

Current status of the autoscaling group.

Enum values:
unknown_group_status
active
scaling_out
scaling_in
refreshing
healing
scaling_failure
deleting
Default: unknown_group_status
created_at
​string | null · date-time

Creation timestamp of the group. (RFC 3339 format)

updated_at
​string | null · date-time

Last update timestamp of the group. (RFC 3339 format)

template_id
​string

The Instance template ID used to create instances in this group.

load_balancer_id
​string | null

Optional load balancer ID.

current_size
​integer · uint32

Current number of instances in the group.

Most recent active alert if any.

minimum_size
​integer · uint32

The minimum number of instances in the group.

maximum_size
​integer · uint32

The maximum number of instances in the group.

Defines which metric the group uses for scaling (cpu, memory, or fixed size).

Enum values:
unknown_scaling_policy_target_type
fixed_size
cpu_target
memory_target
Default: unknown_scaling_policy_target_type
zone
​string

Availability zone of the group.

scaleway.autoscaling.v1alpha2.GroupSummary.ScalingPolicyTargetType

string · enum
Enum values:
unknown_scaling_policy_target_type
fixed_size
cpu_target
memory_target
Default: unknown_scaling_policy_target_type

scaleway.autoscaling.v1alpha2.ListAlertsResponse

List of alerts.

next_page_token
​string | null

Token for the next page of results.

total_count
​integer · uint64

Total number of alerts.

scaleway.autoscaling.v1alpha2.ListGroupsRequest.OrderBy

string · enum
Enum values:
created_at_desc
created_at_asc
Default: created_at_desc

scaleway.autoscaling.v1alpha2.ListGroupsResponse

List of group summaries.

next_page_token
​string | null

Token for the next page of results.

total_count
​integer · uint64

Total number of groups.

scaleway.autoscaling.v1alpha2.ListLogsResponse

List of log entries.

next_page_token
​string | null

Token for the next page of results.

total_count
​integer · uint64

Total number of logs.

scaleway.autoscaling.v1alpha2.ListServersResponse

List of servers.

next_page_token
​string | null

Token for the next page of results.

total_count
​integer · uint64

Total number of servers.

scaleway.autoscaling.v1alpha2.LoadBalancerConfigurationSpec

load_balancer_id
​string | null

ID of the load balancer (set to empty to disable).

List of load balancer backend configurations.

Auto-healing configuration.

scaleway.autoscaling.v1alpha2.LoadBalancerConfigurationSpec.AutoHealing

enabled
​boolean | null

Whether auto-healing is enabled.

grace_period
​string | null

Grace period for health checks. (in seconds)

scaleway.autoscaling.v1alpha2.LoadBalancerConfigurationSpec.Backend

backend_id
​string

ID of the load balancer backend.

IP address family (IPv4 or IPv6).

Enum values:
unknown_address_family
ipv4
ipv6
Default: unknown_address_family
private_network_id
​string | null

Optional private network ID.

scaleway.autoscaling.v1alpha2.Log

timestamp
​string | null · date-time

Timestamp of the log entry. (RFC 3339 format)

Log level (info, warning, error).

Enum values:
unknown_log_level
info
warning
error
Default: unknown_log_level
message
​string

Log message content.

scaleway.autoscaling.v1alpha2.Log.LogLevel

string · enum
Enum values:
unknown_log_level
info
warning
error
Default: unknown_log_level

scaleway.autoscaling.v1alpha2.ScalingPolicySpec

minimum_size
​integer | null · uint32

Minimum number of instances in the group.

maximum_size
​integer | null · uint32

Maximum number of instances in the group.

scale_out_cooldown
​string | null

Cooldown period after a scale out event. (in seconds)

scale_in_cooldown
​string | null

Cooldown period after a scale in event. (in seconds)

scale_in_step
​integer | null · uint32

Number of instances to remove in a single scale in event.

scale_out_step
​integer | null · uint32

Number of instances to add in a single scale out event.

​

Fixed size scaling policy configuration.

​

CPU target scaling policy configuration.

​

Memory target scaling policy configuration.

scaleway.autoscaling.v1alpha2.Server

server_id
​string

ID of the instance server.