Files
02661caabce813aa7246408554746df88e55613f
nova /api-ref /source /os-fping.inc
Matt Riedemann 02661caabc Remove support for /os-fping REST API 
This drops support for the fping compute REST API which
has been deprecated since Newton:
 I1a8a44530be29292561e90d6f7bd7ed512a88ee3
To match the os-cloudpipe and os-certificates removals
the os-fping controller now returns a 410 response.
The related fping_path configuration option is removed
along with the related fping policy rules.
Unit tests are removed and the functional API sample
test is just asserting the 410 response now.
The API sample docs are left intact since the API reference
still builds from those and can be considered more or
less branchless, so people looking at the API reference
can apply it to older deployments of nova before os-fping
was removed.
A release note is started which we can build on for each
nova-network specific API that we remove in this series.
Part of blueprint remova-nova-network
Change-Id: Ia36aaa8f74adc2b540c49523db522cd85ab17ed2
2018年05月10日 15:26:13 -04:00

111 lines
2.4 KiB
ReStructuredText

.. -*- rst -*-
=======================================
Ping instances (os-fping) (DEPRECATED)
=======================================
.. warning::
This API only works with ``nova-network`` which is
deprecated. It should be avoided in any new applications.
These will fail with a 404 starting from microversion 2.36.
It was removed in the 18.0.0 Rocky release.
Pings instances and reports which instances are alive.
Ping Instances
==============
.. rest_method:: GET /os-fping
Runs the fping utility to ping instances and reports which instances are alive.
Specify the ``all_tenants=1`` query parameter to ping instances for all tenants. For example:
::
GET /os-fping?all_tenants=1
Specify the ``include`` and ``exclude`` query parameters to filter the results. For example:
::
GET /os-fping?all_tenants=1&include=uuid1,uuid2&exclude=uuid3,uuid4
Policy defaults enable only users with the administrative role or the
owner of the server to perform this operation. Cloud providers can
change these permissions through the ``policy.json`` file.
Normal response codes: 200
Error response codes: serviceUnavailable(503), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410)
Request
-------
.. rest_parameters:: parameters.yaml
- all_tenants: all_tenants
- include: include
- exclude: exclude
Response
--------
.. rest_parameters:: parameters.yaml
- servers: servers
- alive: alive
- id: server_id
- project_id: project_id
|
**Example Ping Instances**
.. literalinclude:: ../../doc/api_samples/os-fping/fping-get-resp.json
:language: javascript
Ping An Instance
================
.. rest_method:: GET /os-fping/{instance_id}
Runs the fping utility to ping an instance and reports whether the instance is alive.
Policy defaults enable only users with the administrative role or the
owner of the server to perform this operation. Cloud providers can
change these permissions through the ``policy.json`` file.
Normal response codes: 200
Error response codes: serviceUnavailable(503), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410)
Request
-------
.. rest_parameters:: parameters.yaml
- instance_id: instance_id
Response
--------
.. rest_parameters:: parameters.yaml
- server: server
- alive: alive
- id: server_id
- project_id: project_id
|
**Example Ping An Instance**
.. literalinclude:: ../../doc/api_samples/os-fping/fping-get-details-resp.json
:language: javascript