Skip to main content

Resize Auto Scaling Group (Cardinality)

Manually sets the number of running nodes (cardinality) for the group. The requested cardinality must be within the group's [min_nodes, max_nodes] range. Set update_min_nodes: true to also raise min_nodes to the new cardinality so autoscaling does not immediately scale back down. A resize is rejected with 412 Precondition Failed if the group is not in a resizable state (for example while it is already SCALING).

PUT/api/v1/scaler/scalegroups/{scaler_id}

Path parameters

  • scaler_idPathintegerrequired

    The id of the auto scaling group, as returned by List.

    • required
    • must be a valid auto scaling group ID
    example12345

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request.

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region of the group.

    • required
    • must be a valid region name (e.g., Delhi, Chennai)
    example{{location}}

Request body

application/json

object

Manually set the number of running nodes for the group.

cardinalityintegerrequired

Target number of running nodes.

example2
  • required
  • must be between the group's min_nodes and max_nodes
update_min_nodesboolean

When true, also raise min_nodes to the new cardinality so autoscaling does not scale back down.

exampletrue
  • optional
  • defaults to false

Responses

200Successful response
object

Resize confirmation. A resize on a group that is not in a resizable state returns 412 Precondition Failed with the reason in errors (for example "Service cannot be scaled in state: SCALING").

codeinteger
example200
dataobject
errorsobject
messagestring
exampleSuccess