Instance Groups

Download schema

Instance Groups are the core components which allow the number of Instances to be automatically adjusted to meet demand.

List Instance groups

GET

https://api.scaleway.com

/autoscaling/v1alpha1/zones/{zone}/instance-groups

List all Instance groups, for a Scaleway Organization or Scaleway Project. By default, the Instance groups returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

List Instance groups › path Parameters

zone

string · required

The zone you want to target

List Instance groups › query Parameters

order_by

string · enum

Sort order of Instance groups in the response.

Enum values:

created_at_desc

created_at_asc

Default: created_at_desc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of Instance groups to return per page.

List Instance groups › Responses

200

scaleway.autoscaling.v1alpha1.ListInstanceGroupsResponse

scaleway.autoscaling.v1alpha1.InstanceGroup[]

Paginated list of Instance groups.

total_count

integer · uint64

Count of all Instance groups matching the requested criteria.

GET/autoscaling/v1alpha1/zones/{zone}/instance-groups

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/autoscaling/v1alpha1/zones/{zone}/instance-groups"

Example Responses

{
  "instance_groups": [
    {
      "id": "id",
      "project_id": "project_id",
      "name": "name",
      "tags": [
        "string"
      ],
      "instance_template_id": "instance_template_id",
      "capacity": {
        "max_replicas": 0,
        "min_replicas": 0,
        "cooldown_delay": "2.5s"
      },
      "loadbalancer": {
        "id": "id",
        "backend_ids": [
          "string"
        ],
        "private_network_id": "private_network_id"
      },
      "error_messages": [
        "string"
      ],
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "zone": "zone"
    }
  ],
  "total_count": 0
}

json

application/json

Create Instance group

POST

https://api.scaleway.com

/autoscaling/v1alpha1/zones/{zone}/instance-groups

Create a new Instance group. You must specify a template_id, capacity and Load Balancer object.

Create Instance group › path Parameters

zone

string · required

The zone you want to target

Create Instance group › Request Body

project_id

string · required

Project ID to filter for, only Instance groups from this Project will be returned.

name

string · required

Name of Instance group.

template_id

string · required

Template ID (ID of the Instance template to attach to the Instance group).

object · required

Specification of the minimum and maximum replicas for the Instance group, and the cooldown interval between two scaling events.

object · required

Specification of the Load Balancer to link to the Instance group.

tags

string[]

List of tags for the Instance group.

Create Instance group › Responses

200

scaleway.autoscaling.v1alpha1.InstanceGroup

object · required

Specification of the minimum and maximum replicas for the Instance group, and the cooldown interval between two scaling events.

object · required

Specification of the Load Balancer linked to the Instance group.

id

string

Instance group ID.

project_id

string

Project ID of the Instance group.

name

string

Name of the Instance group.

tags

string[]

Instance group tags.

instance_template_id

string

Template ID (ID of the Instance template to attach to the Instance group).

error_messages

string[]

Any configuration errors for dependencies (Load Balancer, Private Network, Instance template etc.).

created_at

string · date-time

Date on which the Instance group was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the Instance group was last updated. (RFC 3339 format)

zone

string

Zone for this resource.

POST/autoscaling/v1alpha1/zones/{zone}/instance-groups

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "capacity": {
        "cooldown_delay": "2.5s",
        "max_replicas": 42,
        "min_replicas": 42
    },
    "loadbalancer": {
        "backend_ids": [
            "string"
        ],
        "id": "string",
        "private_network_id": "string"
    },
    "name": "string",
    "project_id": "string",
    "template_id": "string"
  }' \
  "https://api.scaleway.com/autoscaling/v1alpha1/zones/{zone}/instance-groups"

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "template_id": "template_id",
  "capacity": {
    "max_replicas": 0,
    "min_replicas": 0,
    "cooldown_delay": "2.5s"
  },
  "loadbalancer": {
    "id": "id",
    "backend_ids": [
      "string"
    ],
    "private_network_id": "private_network_id"
  }
}

json

Example Responses

{
  "id": "id",
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "instance_template_id": "instance_template_id",
  "capacity": {
    "max_replicas": 0,
    "min_replicas": 0,
    "cooldown_delay": "2.5s"
  },
  "loadbalancer": {
    "id": "id",
    "backend_ids": [
      "string"
    ],
    "private_network_id": "private_network_id"
  },
  "error_messages": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "zone": "zone"
}

json

application/json

Get Instance group

GET

https://api.scaleway.com

/autoscaling/v1alpha1/zones/{zone}/instance-groups/{instance_group_id}

Retrieve information about an existing Instance group, specified by its instance_group_id. Its full details, including errors, are returned in the response object.

Get Instance group › path Parameters

zone

string · required

The zone you want to target

instance_group_id

string · required

ID of the requested Instance group.

Get Instance group › Responses

200

scaleway.autoscaling.v1alpha1.InstanceGroup

object · required

Specification of the minimum and maximum replicas for the Instance group, and the cooldown interval between two scaling events.

object · required

Specification of the Load Balancer linked to the Instance group.

id

string

Instance group ID.

project_id

string

Project ID of the Instance group.

name

string

Name of the Instance group.

tags

string[]

Instance group tags.

instance_template_id

string

Template ID (ID of the Instance template to attach to the Instance group).

error_messages

string[]

Any configuration errors for dependencies (Load Balancer, Private Network, Instance template etc.).

created_at

string · date-time

Date on which the Instance group was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the Instance group was last updated. (RFC 3339 format)

zone

string

Zone for this resource.

Delete Instance group

DELETE

https://api.scaleway.com

/autoscaling/v1alpha1/zones/{zone}/instance-groups/{instance_group_id}

Delete an existing Instance group, specified by its instance_group_id. Deleting an Instance group is permanent, and cannot be undone.

Delete Instance group › path Parameters

zone

string · required

The zone you want to target

instance_group_id

string · required

ID of the Instance group to delete.

Delete Instance group › Responses

No data returned

Update Instance group

PATCH

https://api.scaleway.com

/autoscaling/v1alpha1/zones/{zone}/instance-groups/{instance_group_id}

Update the parameters of an existing Instance group, specified by its instance_group_id.

Update Instance group › path Parameters

zone

string · required

The zone you want to target

instance_group_id

string · required

Instance group ID to update.

Update Instance group › Request Body

name

string · required

Name of Instance group.

tags

string[]

List of tags for the Load Balancer.

object

Specification of the minimum and maximum replicas for the Instance group, and the cooldown interval between two scaling events.

object

Specification of the Load Balancer to link to the Instance group.

Update Instance group › Responses

200

scaleway.autoscaling.v1alpha1.InstanceGroup

object · required

Specification of the minimum and maximum replicas for the Instance group, and the cooldown interval between two scaling events.

object · required

Specification of the Load Balancer linked to the Instance group.

id

string

Instance group ID.

project_id

string

Project ID of the Instance group.

name

string

Name of the Instance group.

tags

string[]

Instance group tags.

instance_template_id

string

Template ID (ID of the Instance template to attach to the Instance group).

error_messages

string[]

Any configuration errors for dependencies (Load Balancer, Private Network, Instance template etc.).

created_at

string · date-time

Date on which the Instance group was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the Instance group was last updated. (RFC 3339 format)

zone

string

Zone for this resource.

PATCH/autoscaling/v1alpha1/zones/{zone}/instance-groups/{instance_group_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}' \
  "https://api.scaleway.com/autoscaling/v1alpha1/zones/{zone}/instance-groups/{instance_group_id}"

Example Request Body

{
  "name": "name",
  "tags": [
    "string"
  ],
  "capacity": {
    "max_replicas": 0,
    "min_replicas": 0,
    "cooldown_delay": "2.5s"
  },
  "loadbalancer": {
    "backend_ids": [
      "string"
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "instance_template_id": "instance_template_id",
  "capacity": {
    "max_replicas": 0,
    "min_replicas": 0,
    "cooldown_delay": "2.5s"
  },
  "loadbalancer": {
    "id": "id",
    "backend_ids": [
      "string"
    ],
    "private_network_id": "private_network_id"
  },
  "error_messages": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "zone": "zone"
}

json

application/json

List events

GET

https://api.scaleway.com

/autoscaling/v1alpha1/zones/{zone}/instance-groups/{instance_group_id}/events

List all events for a given Instance group. By default, the events are ordered by creation date in descending order, though this can be modified via the order_by field.

List events › path Parameters

zone

string · required

The zone you want to target

instance_group_id

string · required

List all event logs for the Instance group ID.

List events › query Parameters

order_by

string · enum

Sort order of Instance groups in the response.

Enum values:

created_at_desc

created_at_asc

Default: created_at_desc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of Instance groups to return per page.

List events › Responses

200

scaleway.autoscaling.v1alpha1.ListInstanceGroupEventsResponse

scaleway.autoscaling.v1alpha1.InstanceGroupEvent[]

Paginated list of Instance groups.

total_count

integer · uint64

Count of all Instance groups matching the requested criteria.

Instance Templates

List Instance groups

GET

https://api.scaleway.com

/autoscaling/v1alpha1/zones/{zone}/instance-groups

List Instance groups › path Parameters

zone

string · required

The zone you want to target

List Instance groups › query Parameters

order_by

string · enum

Sort order of Instance groups in the response.

Enum values:

created_at_desc

created_at_asc

Default: created_at_desc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of Instance groups to return per page.

List Instance groups › Responses

200

scaleway.autoscaling.v1alpha1.ListInstanceGroupsResponse

scaleway.autoscaling.v1alpha1.InstanceGroup[]

Paginated list of Instance groups.

total_count

integer · uint64

Count of all Instance groups matching the requested criteria.

Create Instance group

POST

https://api.scaleway.com

/autoscaling/v1alpha1/zones/{zone}/instance-groups

Create a new Instance group. You must specify a template_id, capacity and Load Balancer object.

Create Instance group › path Parameters

zone

string · required

The zone you want to target

Create Instance group › Request Body

project_id

string · required

Project ID to filter for, only Instance groups from this Project will be returned.

name

string · required

Name of Instance group.

template_id

string · required

Template ID (ID of the Instance template to attach to the Instance group).

object · required

Specification of the minimum and maximum replicas for the Instance group, and the cooldown interval between two scaling events.

object · required

Specification of the Load Balancer to link to the Instance group.

tags

string[]

List of tags for the Instance group.

Create Instance group › Responses

200

scaleway.autoscaling.v1alpha1.InstanceGroup

object · required

Specification of the minimum and maximum replicas for the Instance group, and the cooldown interval between two scaling events.

object · required

Specification of the Load Balancer linked to the Instance group.

id

string

Instance group ID.

project_id

string

Project ID of the Instance group.

name

string

Name of the Instance group.

tags

string[]

Instance group tags.

instance_template_id

string

Template ID (ID of the Instance template to attach to the Instance group).

error_messages

string[]

Any configuration errors for dependencies (Load Balancer, Private Network, Instance template etc.).

created_at

string · date-time

Date on which the Instance group was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the Instance group was last updated. (RFC 3339 format)

zone

string

Zone for this resource.

Get Instance group

GET

https://api.scaleway.com

/autoscaling/v1alpha1/zones/{zone}/instance-groups/{instance_group_id}

Retrieve information about an existing Instance group, specified by its instance_group_id. Its full details, including errors, are returned in the response object.

Get Instance group › path Parameters

zone

string · required

The zone you want to target

instance_group_id

string · required

ID of the requested Instance group.

Get Instance group › Responses

200

scaleway.autoscaling.v1alpha1.InstanceGroup

object · required

Specification of the minimum and maximum replicas for the Instance group, and the cooldown interval between two scaling events.

object · required

Specification of the Load Balancer linked to the Instance group.

id

string

Instance group ID.

project_id

string

Project ID of the Instance group.

name

string

Name of the Instance group.

tags

string[]

Instance group tags.

instance_template_id

string

Template ID (ID of the Instance template to attach to the Instance group).

error_messages

string[]

Any configuration errors for dependencies (Load Balancer, Private Network, Instance template etc.).

created_at

string · date-time

Date on which the Instance group was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the Instance group was last updated. (RFC 3339 format)

zone

string

Zone for this resource.

Delete Instance group

DELETE

https://api.scaleway.com

/autoscaling/v1alpha1/zones/{zone}/instance-groups/{instance_group_id}

Delete an existing Instance group, specified by its instance_group_id. Deleting an Instance group is permanent, and cannot be undone.

Delete Instance group › path Parameters

zone

string · required

The zone you want to target

instance_group_id

string · required

ID of the Instance group to delete.

Delete Instance group › Responses

No data returned

Update Instance group

PATCH

https://api.scaleway.com

/autoscaling/v1alpha1/zones/{zone}/instance-groups/{instance_group_id}

Update the parameters of an existing Instance group, specified by its instance_group_id.

Update Instance group › path Parameters

zone

string · required

The zone you want to target

instance_group_id

string · required

Instance group ID to update.

Update Instance group › Request Body

name

string · required

Name of Instance group.

tags

string[]

List of tags for the Load Balancer.

object

Specification of the minimum and maximum replicas for the Instance group, and the cooldown interval between two scaling events.

object

Specification of the Load Balancer to link to the Instance group.

Update Instance group › Responses

200

scaleway.autoscaling.v1alpha1.InstanceGroup

object · required

Specification of the minimum and maximum replicas for the Instance group, and the cooldown interval between two scaling events.

object · required

Specification of the Load Balancer linked to the Instance group.

id

string

Instance group ID.

project_id

string

Project ID of the Instance group.

name

string

Name of the Instance group.

tags

string[]

Instance group tags.

instance_template_id

string

Template ID (ID of the Instance template to attach to the Instance group).

error_messages

string[]

Any configuration errors for dependencies (Load Balancer, Private Network, Instance template etc.).

created_at

string · date-time

Date on which the Instance group was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the Instance group was last updated. (RFC 3339 format)

zone

string

Zone for this resource.

List events

GET

https://api.scaleway.com

/autoscaling/v1alpha1/zones/{zone}/instance-groups/{instance_group_id}/events

List all events for a given Instance group. By default, the events are ordered by creation date in descending order, though this can be modified via the order_by field.

List events › path Parameters

zone

string · required

The zone you want to target

instance_group_id

string · required

List all event logs for the Instance group ID.

List events › query Parameters

order_by

string · enum

Sort order of Instance groups in the response.

Enum values:

created_at_desc

created_at_asc

Default: created_at_desc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of Instance groups to return per page.

List events › Responses

200

scaleway.autoscaling.v1alpha1.ListInstanceGroupEventsResponse

scaleway.autoscaling.v1alpha1.InstanceGroupEvent[]

Paginated list of Instance groups.

total_count

integer · uint64

Count of all Instance groups matching the requested criteria.