Set allocator settings

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

Auth

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

Path parameters

allocator_id string required: The allocator identifier.

Query parameters

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

Request body

The allocator settings to apply

capacity integer · format: 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

Returns the updated settings for the specified allocator

application/json

capacity integer · format: 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.

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

application/json

View as Markdown

Examples

Request curl 1 / 1 language

curl Shell

curl -X PUT "${API_URL}/platform/infrastructure/allocators/${ALLOCATOR_ID}/settings" \
  -u "${USERNAME}:${PASSWORD}" \
  -H "Content-Type: application/json" \
  -d '{}'

Generated from the API spec

Response

{
  "capacity": 0
}

Generated from the API spec

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

Generated from the API spec