a09defd661
The API reference for POST /allocations [1] and PUT
/allocations/{consumer_uuid} [2] specifically mentions that you can get
a 409 on provider/inventory conflict. In microversion 1.28, it also
became possible to get a 409 on an allocation (consumer generation)
conflict.
In the process of adding that information, it became evident that we
weren't doing a good job explaining the whole generation thing in
general, so this commit also adds a descriptive section to the front
matter of the API reference.
Links are included from the updated descriptions for the two affected
allocations operations. Future commits can add links from other
appropriate sections of the reference (e.g. the parameters.yaml entries
for resource provider and consumer generation fields). Future commits
could also enhance the descriptions of error codes for other operations
to (at least) the level of detail at which these have ended up.
[1] https://developer.openstack.org/api-ref/placement/?expanded=manage-allocations-detail#manage-allocations
[2] https://developer.openstack.org/api-ref/placement/?expanded=update-allocations-detail#update-allocations
Change-Id: I42e76785e0fe456b107fe843dbb242f2c5f5b9f7
Story: #2006180
Task: #35705
71 lines
2.8 KiB
PHP
71 lines
2.8 KiB
PHP
======
|
|
Errors
|
|
======
|
|
|
|
When there is an error interacting with the placement API, the response will
|
|
include a few different signals of what went wrong, include the status header
|
|
and information in the response body. The structure of the ``JSON`` body of an
|
|
error response is defined by the OpenStack errors_ guideline.
|
|
|
|
**HTTP Status Code**
|
|
The ``Status`` header of the response will include a code, defined by
|
|
:rfc:`7231#section-6` that gives a general overview of the problem.
|
|
This value also shows up in a ``status`` attribute in the body of the
|
|
response.
|
|
|
|
**Detail Message**
|
|
A textual description of the error condition, in a ``detail`` attribute.
|
|
The value is usually the message associated with whatever exception
|
|
happened within the service.
|
|
|
|
**Error Code**
|
|
When the microversion is ``>=1.23`` responses will also include a ``code``
|
|
attribute in the ``JSON`` body. These are documented below. Where a
|
|
response does not use a specific code ``placement.undefined_code`` is
|
|
present.
|
|
|
|
.. note:: In some cases, for example when keystone is being used and no
|
|
authentication information is provided in a request (causing a
|
|
``401`` response), the structure of the error response will not match
|
|
the above because the error is produced by code other than the
|
|
placement service.
|
|
|
|
.. _`error_codes`:
|
|
|
|
Error Codes
|
|
===========
|
|
|
|
The defined errors are:
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Code
|
|
- Meaning
|
|
* - ``placement.undefined_code``
|
|
- The default code used when a specific code has not been defined or is
|
|
not required.
|
|
* - ``placement.inventory.inuse``
|
|
- An attempt has been made to remove or shrink inventory that has capacity
|
|
in use.
|
|
* - ``placement.concurrent_update``
|
|
- Another operation has concurrently made a request that involves one or
|
|
more of the same resources referenced in this request, changing state.
|
|
The current state should be retrieved to determine if the desired
|
|
operation should be retried.
|
|
* - ``placement.duplicate_name``
|
|
- A resource of this type already exists with the same name, and duplicate
|
|
names are not allowed.
|
|
* - ``placement.resource_provider.inuse``
|
|
- An attempt was made to remove a resource provider, but there are
|
|
allocations against its inventory.
|
|
* - ``placement.resource_provider.cannot_delete_parent``
|
|
- An attempt was made to remove a resource provider, but it has one or
|
|
more child providers. They must be removed first in order to remove this
|
|
provider.
|
|
* - ``placement.resource_provider.not_found``
|
|
- A resource provider mentioned in an operation involving multiple
|
|
resource providers, such as :ref:`reshaper`, does not exist.
|
|
|
|
.. _errors: https://specs.openstack.org/openstack/api-wg/guidelines/errors.html
|