Set allocator settings

PUT /platform/infrastructure/allocators/{allocator_id}/settings

Overwrites the allocator settings with the specified settings. WARNING: Any unspecified fields are deleted.

Path parameters

Query parameters

  • version string

    Checks for conflicts against the metadata version, then returns the value in the x-cloud-resource-version header.

Body Required

The allocator settings to apply

  • capacity integer(int32)

    A memory capacity (in MB) that overrides the capacity defined during installation - requires separate restart of Allocator services on each host to take full effect.

Responses

  • 200

    Returns the updated settings for the specified allocator

    Hide response attribute Show response attribute object
    • capacity integer(int32)

      A memory capacity (in MB) that overrides the capacity defined during installation - requires separate restart of Allocator services on each host to take full effect.
  • 404

    The allocator specified by {allocator_id} cannot be found. (code: allocators.allocator_not_found)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is allocators.allocator_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
PUT /platform/infrastructure/allocators/{allocator_id}/settings 
curl \
 -X PUT https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/settings \
 -d '{"capacity":42}'
Request examples 
{
  "capacity": 42
}
Response examples (200) 
{
  "capacity": 42
}
Response examples (404) 
# Headers
x-cloud-error-codes: allocators.allocator_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}