api-ref, os-fping.inc
-Updated response parameters in parameters.yaml. -Verified body text, methods, parameters. Change-Id: I35c9e95c8223072c37da33fddf9633bba82a2544
This commit is contained in:
parent
54d66ee894
commit
1f3345593e
|
@ -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
|
||||
|
||||
|
|
|
@ -697,6 +697,12 @@ alias:
|
|||
in: body
|
||||
required: true
|
||||
type: string
|
||||
alive:
|
||||
description: |
|
||||
Returns true if the instance is alive.
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
architecture:
|
||||
description: |
|
||||
The name of the cpu architecture.
|
||||
|
@ -2014,7 +2020,7 @@ progress:
|
|||
type: integer
|
||||
project_id:
|
||||
description: |
|
||||
Creates the cloudpipe for a project. If omitted, the project ID defaults to the
|
||||
The UUID of the project. If omitted, the project ID defaults to the
|
||||
calling tenant.
|
||||
in: body
|
||||
required: false
|
||||
|
@ -2263,7 +2269,7 @@ security_groups_quota_optional:
|
|||
type: integer
|
||||
server:
|
||||
description: |
|
||||
server.
|
||||
A ``server`` object.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
|
|
Loading…
Reference in New Issue