Get allocator settings

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

Retrieves the allocator override settings.

Path parameters

  • allocator_id string Required

    The allocator identifier.

Responses

  • 200 application/json

    Returns the settings for the specified Allocator

    Hide headers attributes Show headers attributes
    • x-cloud-resource-version string

      The resource version, which is used to avoid update conflicts with concurrent operations

    • x-cloud-resource-created string

      The date-time when the resource was created (ISO format relative to UTC)

    • x-cloud-resource-last-modified string

      The date-time when the resource was last modified (ISO format relative to UTC)

    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 application/json

    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

GET /platform/infrastructure/allocators/{allocator_id}/settings
curl \
 --request GET 'https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/settings' \
 --user "username:password"