16b29024c2
Add a section to the api-ref describing the error codes that some responses produce. Note in the contributor docs that this should be updated when one is added. The reshaper docs is adjusted so a ref can be made to it from the errors. The implicit link to the header that would be the norm there doesn't work as there are two headers named "Reshaper". Change-Id: I89bbd383ba102fdd707ccc9f2fc973c6dd841fa8 Closes-Bug: #1794712
70 lines
2.8 KiB
PHP
70 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
|
|
===========
|
|
|
|
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
|