diff options
author | Sean Dague <sean@dague.net> | 2016-04-12 09:03:46 -0400 |
---|---|---|
committer | Sean Dague <sean@dague.net> | 2016-04-13 07:34:45 -0400 |
commit | d4e27714405e064ba8f62070e8c48d7fa71b6996 (patch) | |
tree | bd8b560fdc3864ea1c121b069926cd6b1d569556 /api-ref/source/os-floating-ips-bulk.inc | |
parent | f1fa7eb15a8b4a081d8d8afd3e6d80302c20e39e (diff) | |
download | nova-d4e27714405e064ba8f62070e8c48d7fa71b6996.tar.gz |
Import RST files for documentation
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.
Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
Diffstat (limited to 'api-ref/source/os-floating-ips-bulk.inc')
-rw-r--r-- | api-ref/source/os-floating-ips-bulk.inc | 132 |
1 files changed, 132 insertions, 0 deletions
diff --git a/api-ref/source/os-floating-ips-bulk.inc b/api-ref/source/os-floating-ips-bulk.inc new file mode 100644 index 0000000000..5ce701dfec --- /dev/null +++ b/api-ref/source/os-floating-ips-bulk.inc @@ -0,0 +1,132 @@ +.. -*- rst -*- + +========================================== + Floating IPs bulk (os-floating-ips-bulk) +========================================== + +(nova-network only) Bulk-creates, deletes, and lists floating IPs. +Default pool name is ``nova``. + +To view available pools, use the ``os-floating-ip-pools`` extension. + +List Floating Ips +================= + +.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ips-bulk + +Lists all floating IPs. + +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 + +Response +^^^^^^^^ + +**Example List Floating Ips: JSON request** + +.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.json + :language: javascript + +Create Floating Ips +=================== + +.. rest_method:: POST /v2.1/{tenant_id}/os-floating-ips-bulk + +Bulk-creates floating IPs. + +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 + - ip_range: ip_range + +**Example Create Floating Ips: JSON request** + +.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.json + :language: javascript + +Response +^^^^^^^^ + +**Example Create Floating Ips: JSON request** + +.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.json + :language: javascript + +Bulk-Delete Floating Ips +======================== + +.. rest_method:: POST /v2.1/{tenant_id}/os-floating-ips-bulk/delete + +Bulk-deletes floating IPs. + +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 + - ip_range: ip_range + +**Example Bulk-Delete Floating Ips: JSON request** + +.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-req.json + :language: javascript + +Response +^^^^^^^^ + +**Example Bulk-Delete Floating Ips: JSON request** + +.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.json + :language: javascript + +List Floating Ips By Host +========================= + +.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ips-bulk/{host_name} + +Lists all floating IPs for a host. + +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 + - host_name: host_name + +Response +^^^^^^^^ + +**Example List Floating Ips By Host: JSON request** + +.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.json + :language: javascript + |