Path parameters

• allocator_id string Required

  The allocator identifier.

Query parameters

• reason string

  Provides a reason for changing the maintenance mode which will appear as a message on the allocator.

Responses

• 202

  The start maintenance mode command was issued successfully

  Additional properties are allowed.

• 403

  The start maintenance mode command was prohibited for the given allocator. (code: root.unauthorized.rbac)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is root.unauthorized.rbac.

  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

• 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