nova/api-ref/source/os-fping.inc
Sean Dague d929b9fc76 add tags to files for the content verification phase
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef

Part of bp:api-ref-in-rst

Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
2016-04-20 16:21:58 -04:00

85 lines
2.3 KiB
ReStructuredText

.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
===========================
Ping instances (os-fping)
===========================
Pings instances and reports which ones are alive.
Ping Instances
==============
.. rest_method:: GET /v2.1/{tenant_id}/os-fping
Run the fping utility to ping instances and report which ones are alive.
Specify the ``all_tenants=1`` query parameter to ping instances for all tenants. For example:
GET /os-fping?all_tenants=1Specify the ``include`` and ``exclude`` query parameters to filter the results. For example:
GET /os-fping?all_tenants=1&include=uuid1,uuid2&exclude=uuid3,uuid4Policy 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: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Query Parameters
~~~~~~~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- all_tenants: all_tenants
- include: include
- exclude: exclude
Response
--------
**Example Ping Instances: JSON response**
.. literalinclude:: ../../doc/api_samples/os-fping/fping-get-resp.json
:language: javascript
Ping An Instance
================
.. rest_method:: GET /v2.1/{tenant_id}/os-fping/{instance_id}
Run the fping utility to ping an instance and report whether it 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: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- instance_id: instance_id
Response
--------
**Example Ping An Instance: JSON response**
.. literalinclude:: ../../doc/api_samples/os-fping/fping-get-details-resp.json
:language: javascript