diff options
| author | Karen Bradshaw <kbhawkey@gmail.com> | 2016-05-19 12:16:31 -0400 |
|---|---|---|
| committer | Karen Bradshaw <kbhawkey@gmail.com> | 2016-05-21 19:48:37 -0400 |
| commit | 1f3345593e27e961bebd3a8c5fcec174695461a7 (patch) | |
| tree | 014c3324cf05db630ff1571f4c9bffc1c0688574 /api-ref/source/os-fping.inc | |
| parent | 54d66ee894cb487aa2ff3c394862cb9c3763443d (diff) | |
| download | nova-1f3345593e27e961bebd3a8c5fcec174695461a7.tar.gz | |
api-ref, os-fping.inc
-Updated response parameters in parameters.yaml.
-Verified body text, methods, parameters.
Change-Id: I35c9e95c8223072c37da33fddf9633bba82a2544
Diffstat (limited to 'api-ref/source/os-fping.inc')
| -rw-r--r-- | api-ref/source/os-fping.inc | 49 |
1 files changed, 32 insertions, 17 deletions
diff --git a/api-ref/source/os-fping.inc b/api-ref/source/os-fping.inc index 00b8921553..2fbd761753 100644 --- a/api-ref/source/os-fping.inc +++ b/api-ref/source/os-fping.inc @@ -1,26 +1,30 @@ .. -*- rst -*- -.. needs:parameter_verification -.. needs:example_verification -.. needs:body_verification =========================== Ping instances (os-fping) =========================== -Pings instances and reports which ones are alive. +Pings instances and reports which instances 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. +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=1Specify the ``include`` and ``exclude`` query parameters to filter the results. 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 -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. @@ -35,12 +39,6 @@ Request .. rest_parameters:: parameters.yaml - tenant_id: tenant_id - -Query Parameters -~~~~~~~~~~~~~~~~ - -.. rest_parameters:: parameters.yaml - - all_tenants: all_tenants - include: include - exclude: exclude @@ -48,7 +46,16 @@ Query Parameters Response -------- -**Example Ping Instances: JSON 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 @@ -58,7 +65,7 @@ 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. +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 @@ -80,8 +87,16 @@ Request Response -------- -**Example Ping An Instance: JSON 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 - |