6.2.2. Update scaling group configuration

 
MethodURIDescription
PUT/v1.0/{tenantId}/groups/{groupId}/config

Updates the configuration for the scaling group.

Updates the configuration of an existing scaling group. To change the configuration, specify the new configuration in the request body in JSON format. Configuration elements include the minimum number of entities, the maximum number of entities, the global cooldown time, and other metadata. If the update is successful, no response body is returned.

[Note]Note

All Rackspace Auto Scale update (PUT) operations completely replace the configuration being updated. Empty values (for example, { })in the update are accepted and overwrite previously specified parameters. New parameters can be specified. All create (POST) parameters, even optional ones, are required for the update operation.

This table shows the possible response codes for this operation:

Response CodeNameDescription
204Success But No ContentThe update group configuration request succeeded.
400InvalidJsonErrorThe request is refused because the body was invalid JSON".
400ValidationErrorThe request body had valid JSON but with unexpected properties or values in it. Please note that there can be many combinations that cause this error. We will try to list the most common mistakes users are likely to make in a particular request. ".
400InvalidMinEntitiesThe minEntities value is greater than the maxEntities value.
401InvalidCredentialsThe X-Auth-Token the user supplied is bad.
403ForbiddenThe user does not have permission to perform the resource; for example, the user only has an observer role and attempted to perform something only available to a user with an admin role. Note, some API nodes also use this status code for other things.
404NoSuchScalingGroupErrorThe specified scaling group was not found.
405InvalidMethodThe method used is unavailable for the endpoint.
413RateLimitErrorThe user has surpassed their rate limit.
415UnsupportedMediaTypeThe request is refused because the content type of the request is not "application/json".
500InternalErrorAn error internal to the application has occurred, please file a bug report.
503ServiceUnavailableThe requested service is unavailable, please file a bug report.

 6.2.2.1. Request

This table shows the header parameters for the update scaling group configuration request:

NameTypeDescription

X-Auth-Token

​String

(Required)

A valid authentication token.

This table shows the URI parameters for the update scaling group configuration request:

NameTypeDescription

{tenantId}

​String

A subscriber to the auto scaling service.

{groupId}

​U​U​ID

A scaling group.

This list shows the body parameters for the request:

  • maxEntities: Object. Required.

    The maximum number of entities that are allowed in the scaling group. If left unconfigured, defaults to 1000. If this value is provided it must be set to an integer between 0 and 1000.

  • cooldown: Integer. Required.

    The cooldown period, in seconds, before more changes can happen. This number must be an integer between 0 and 86400 (24 hrs).

  • name: String. Required.

    The name of the scaling group. This name does not have to be unique.

  • minEntities: Integer. Required.

    The minimum number of entities in the scaling group. This number must be an integer between 0 and 1000.

  • metadata: Object. Required.

    This optional parameter specifies custom metadata for your group configuration. You can use the metadata parameter for custom automation, but it does not change any functionality in Auto Scale. There currently is no limitation on depth.

 

Example 6.8. Update scaling group configuration: JSON request

{
   "name":"workers",
   "cooldown":60,
   "minEntities":5,
   "maxEntities":100,
   "metadata":{
      "firstkey":"this is a string",
      "secondkey":"1"
   }
}



loading table of contents...