openstack
/
nova
Code Issues Proposed changes

move sphinx h3 to '-' instead of '^' 

In the sphinx document h3 is supposed to be '-' not '^':

=, for sections
-, for subsections
^, for subsubsections

We have to enforce consistency here because we're processing included
files which all have to agree, otherwise it's a sphinx error.

Part of bp:api-ref-in-rst

Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
This commit is contained in:
Sean Dague 2016-04-14 13:10:59 -04:00
parent ccee8b3c13
commit 9526462326
56 changed files with 438 additions and 438 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api-ref/source/diagnostics.inc
View File

@ -21,7 +21,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -29,7 +29,7 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------
**Example Server diagnostics: JSON response**

4
api-ref/source/extensions.inc
View File

@ -24,7 +24,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -32,7 +32,7 @@ Request
- alias: alias
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml

20
api-ref/source/flavors.inc
View File

@ -19,7 +19,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -38,7 +38,7 @@ Query Parameters
- marker: marker
Response
^^^^^^^^
--------
**Example List Flavors: JSON request**
@ -58,7 +58,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -70,7 +70,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Flavor: JSON request**
@ -90,7 +90,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -98,7 +98,7 @@ Request
- flavor_id: flavor_id
Response
^^^^^^^^
--------
**Example Show Flavor Details: JSON request**
@ -118,7 +118,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -126,7 +126,7 @@ Request
- flavor_id: flavor_id
Response
^^^^^^^^
--------
List Flavors With Details
=========================
@ -141,7 +141,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -160,7 +160,7 @@ Query Parameters
- marker: marker
Response
^^^^^^^^
--------
**Example List Flavors With Details: JSON request**

20
api-ref/source/images.inc
View File

@ -27,7 +27,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -35,7 +35,7 @@ Request
- image_id: image_id
Response
^^^^^^^^
--------
**Example Show Image Details: JSON request**
@ -55,7 +55,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -63,7 +63,7 @@ Request
- image_id: image_id
Response
^^^^^^^^
--------
Show Image Metadata Item Details
================================
@ -78,7 +78,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -87,7 +87,7 @@ Request
- key: key
Response
^^^^^^^^
--------
**Example Show Image Metadata Item Details: JSON request**
@ -107,7 +107,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -121,7 +121,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Or Update Image Metadata Item: JSON request**
@ -141,7 +141,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -150,5 +150,5 @@ Request
- key: key
Response
^^^^^^^^
--------

8
api-ref/source/ips.inc
View File

@ -22,7 +22,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -30,7 +30,7 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------
**Example List Ips: JSON request**
@ -52,7 +52,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -61,7 +61,7 @@ Request
- network_label: network_label
Response
^^^^^^^^
--------
**Example Show Ip Details: JSON request**

4
api-ref/source/limits.inc
View File

@ -19,14 +19,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example Show Rate And Absolute Limits: JSON request**

24
api-ref/source/metadata.inc
View File

@ -25,7 +25,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -33,7 +33,7 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------
**Example List All Metadata: JSON request**
@ -57,7 +57,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -70,7 +70,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Or Replace Metadata Items: JSON request**
@ -94,7 +94,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -107,7 +107,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Update Metadata Items: JSON request**
@ -129,7 +129,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -138,7 +138,7 @@ Request
- key: key
Response
^^^^^^^^
--------
**Example Show Metadata Item Details: JSON request**
@ -162,7 +162,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -176,7 +176,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Or Update Metadata Item: JSON request**
@ -198,7 +198,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -207,5 +207,5 @@ Request
- key: key
Response
^^^^^^^^
--------

16
api-ref/source/os-agents.inc
View File

@ -24,7 +24,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -36,7 +36,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Agent Build: JSON request**
@ -56,7 +56,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -69,7 +69,7 @@ Request
- version: version
Response
^^^^^^^^
--------
**Example List Agent Builds: JSON request**
@ -89,14 +89,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
Update Agent Build
==================
@ -111,7 +111,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -127,7 +127,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml

32
api-ref/source/os-aggregates.inc
View File

@ -21,7 +21,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -33,7 +33,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Aggregate: JSON request**
@ -53,7 +53,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -65,7 +65,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example List Aggregates: JSON request**
@ -85,7 +85,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -98,7 +98,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Show Aggregate Details: JSON request**
@ -118,7 +118,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -126,7 +126,7 @@ Request
- aggregate_id: aggregate_id
Response
^^^^^^^^
--------
Update Aggregate
================
@ -141,7 +141,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -154,7 +154,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Update Aggregate: JSON request**
@ -176,7 +176,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -189,7 +189,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Add Host: JSON request**
@ -211,7 +211,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -224,7 +224,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Or Update Aggregate Metadata: JSON request**
@ -246,7 +246,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -259,7 +259,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Remove Host: JSON request**

8
api-ref/source/os-assisted-volume-snapshots.inc
View File

@ -23,7 +23,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -41,7 +41,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -70,7 +70,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -85,5 +85,5 @@ Query Parameters
- delete_info: delete_info
Response
^^^^^^^^
--------

8
api-ref/source/os-availability-zone.inc
View File

@ -19,14 +19,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example Get availability zone information: JSON response**
@ -46,14 +46,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example Get detailed availability zone information: JSON response**

24
api-ref/source/os-baremetal-nodes.inc
View File

@ -25,7 +25,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -43,7 +43,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Add Bare Metal Node: JSON request**
@ -68,7 +68,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -76,7 +76,7 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------
**Example List Bare Metal Nodes: JSON request**
@ -96,7 +96,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -109,7 +109,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Add Interface To Bare Metal Node: JSON request**
@ -129,7 +129,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -142,7 +142,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Show Bare Metal Node Details
============================
@ -161,7 +161,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -170,7 +170,7 @@ Request
- node_id: node_id
Response
^^^^^^^^
--------
**Example Show Bare Metal Node Details: JSON request**
@ -190,7 +190,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -199,5 +199,5 @@ Request
- node_id: node_id
Response
^^^^^^^^
--------

16
api-ref/source/os-cells.inc
View File

@ -22,14 +22,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Cells: JSON request**
@ -51,14 +51,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Cells With Details: JSON request**
@ -80,7 +80,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -88,7 +88,7 @@ Request
- cell_id: cell_id
Response
^^^^^^^^
--------
**Example Show Cell Data: JSON request**
@ -110,7 +110,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -118,7 +118,7 @@ Request
- cell_id: cell_id
Response
^^^^^^^^
--------
**Example Show Cell Capacities: JSON request**

8
api-ref/source/os-certificates.inc
View File

@ -19,14 +19,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example Create Certificate: JSON request**
@ -46,7 +46,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -54,7 +54,7 @@ Request
- certificate_id: certificate_id
Response
^^^^^^^^
--------
**Example Show Certificate Details: JSON request**

12
api-ref/source/os-cloudpipe.inc
View File

@ -19,14 +19,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Cloudpipes: JSON request**
@ -46,7 +46,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -59,7 +59,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Cloudpipe: JSON request**
@ -79,7 +79,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -93,5 +93,5 @@ Request
:language: javascript
Response
^^^^^^^^
--------

20
api-ref/source/os-consoles.inc
View File

@ -19,7 +19,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -27,7 +27,7 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------
Lists Consoles
==============
@ -42,7 +42,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -50,7 +50,7 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------
**Example List consoles: JSON response**
@ -70,7 +70,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -79,7 +79,7 @@ Request
- console_id: console_id
Response
^^^^^^^^
--------
**Example List consoles: JSON response**
@ -99,7 +99,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -108,7 +108,7 @@ Request
- console_id: console_id
Response
^^^^^^^^
--------
Show Console Authentication Token
=================================
@ -125,7 +125,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -133,7 +133,7 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------
**Example List consoles: JSON response**

8
api-ref/source/os-fixed-ips.inc
View File

@ -20,7 +20,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -28,7 +28,7 @@ Request
- fixed_ip: fixed_ip
Response
^^^^^^^^
--------
**Example Show Fixed Ip Details: JSON request**
@ -50,7 +50,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -63,5 +63,5 @@ Request
:language: javascript
Response
^^^^^^^^
--------

12
api-ref/source/os-flavor-access.inc
View File

@ -23,14 +23,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Flavor Access Information For Given Flavor: JSON request**
@ -52,7 +52,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -65,7 +65,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Add Flavor Access To Tenant: JSON request**
@ -87,7 +87,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -100,7 +100,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Remove Flavor Access From Tenant: JSON request**

20
api-ref/source/os-flavor-extra-specs.inc
View File

@ -20,7 +20,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -33,7 +33,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Extra Specs For A Flavor: JSON request**
@ -53,7 +53,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -66,7 +66,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example List Extra Specs For A Flavor: JSON request**
@ -86,7 +86,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -95,7 +95,7 @@ Request
- flavor_extra_spec_key: flavor_extra_spec_key
Response
^^^^^^^^
--------
**Example Show An Extra Spec For A Flavor: JSON request**
@ -115,7 +115,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -129,7 +129,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Update An Extra Spec For A Flavor: JSON request**
@ -149,7 +149,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -158,5 +158,5 @@ Request
- flavor_extra_spec_key: flavor_extra_spec_key
Response
^^^^^^^^
--------

28
api-ref/source/os-floating-ip-dns.inc
View File

@ -20,14 +20,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Dns Domains: JSON request**
@ -47,7 +47,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -60,7 +60,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Or Update Dns Domain: JSON request**
@ -80,7 +80,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -88,7 +88,7 @@ Request
- domain: domain
Response
^^^^^^^^
--------
Create Or Update Dns Entry
==========================
@ -103,7 +103,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -117,7 +117,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Or Update Dns Entry: JSON request**
@ -137,7 +137,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -146,7 +146,7 @@ Request
- name: name
Response
^^^^^^^^
--------
**Example Find Unique Dns Entry: JSON request**
@ -166,7 +166,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -175,7 +175,7 @@ Request
- name: name
Response
^^^^^^^^
--------
List Dns Entries
================
@ -190,7 +190,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -199,7 +199,7 @@ Request
- ip: ip
Response
^^^^^^^^
--------
**Example List Dns Entries: JSON request**

4
api-ref/source/os-floating-ip-pools.inc
View File

@ -21,14 +21,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml

16
api-ref/source/os-floating-ips-bulk.inc
View File

@ -22,14 +22,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Floating Ips: JSON request**
@ -49,7 +49,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -62,7 +62,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Floating Ips: JSON request**
@ -82,7 +82,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -95,7 +95,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Bulk-Delete Floating Ips: JSON request**
@ -115,7 +115,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -123,7 +123,7 @@ Request
- host_name: host_name
Response
^^^^^^^^
--------
**Example List Floating Ips By Host: JSON request**

16
api-ref/source/os-floating-ips.inc
View File

@ -42,14 +42,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Floating Ip Addresses: JSON request**
@ -73,7 +73,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -86,7 +86,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create (Allocate) Floating Ip Address: JSON request**
@ -108,7 +108,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -116,7 +116,7 @@ Request
- floating_ip_id: floating_ip_id
Response
^^^^^^^^
--------
**Example Show Floating Ip Address Details: JSON request**
@ -140,7 +140,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -148,5 +148,5 @@ Request
- floating_ip_id: floating_ip_id
Response
^^^^^^^^
--------

8
api-ref/source/os-fping.inc
View File

@ -25,7 +25,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -41,7 +41,7 @@ Query Parameters
- exclude: exclude
Response
^^^^^^^^
--------
**Example Ping Instances: JSON request**
@ -63,7 +63,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -71,7 +71,7 @@ Request
- instance_id: instance_id
Response
^^^^^^^^
--------
**Example Ping An Instance: JSON request**

24
api-ref/source/os-hosts.inc
View File

@ -21,14 +21,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Hosts: JSON request**
@ -48,7 +48,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -61,7 +61,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Enable Host: JSON request**
@ -81,7 +81,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -89,7 +89,7 @@ Request
- host_name: host_name
Response
^^^^^^^^
--------
**Example Show Host Details: JSON request**
@ -109,7 +109,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -117,7 +117,7 @@ Request
- host_name: host_name
Response
^^^^^^^^
--------
**Example Reboot Host: JSON request**
@ -137,7 +137,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -145,7 +145,7 @@ Request
- host_name: host_name
Response
^^^^^^^^
--------
**Example Shut Down Host: JSON request**
@ -165,7 +165,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -173,7 +173,7 @@ Request
- host_name: host_name
Response
^^^^^^^^
--------
**Example Start Host: JSON request**

16
api-ref/source/os-hypervisors.inc
View File

@ -21,14 +21,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Hypervisors: JSON request**
@ -48,14 +48,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example Show Hypervisor Statistics: JSON request**
@ -75,7 +75,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -83,7 +83,7 @@ Request
- hypervisor_id: hypervisor_id
Response
^^^^^^^^
--------
**Example Show Hypervisor Details: JSON request**
@ -103,7 +103,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -111,7 +111,7 @@ Request
- hypervisor_id: hypervisor_id
Response
^^^^^^^^
--------
**Example Show Hypervisor Uptime: JSON request**

8
api-ref/source/os-instance-actions.inc
View File

@ -22,7 +22,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -30,7 +30,7 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------
**Example List Actions For Server: JSON request**
@ -50,7 +50,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -59,7 +59,7 @@ Request
- request_id: request_id
Response
^^^^^^^^
--------
**Example Show Server Action Details: JSON request**

8
api-ref/source/os-instance-usage-audit-log.inc
View File

@ -19,14 +19,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Usage Audits For An Instance: JSON request**
@ -46,7 +46,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -60,7 +60,7 @@ Query Parameters
- before_timestamp: before_timestamp
Response
^^^^^^^^
--------
**Example List Usage Audits Before Specified Time: JSON request**

16
api-ref/source/os-interface.inc
View File

@ -21,7 +21,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -38,7 +38,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -67,7 +67,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -75,7 +75,7 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -104,7 +104,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -113,7 +113,7 @@ Request
- port_id: port_id
Response
^^^^^^^^
--------
**Example Show Port Interface Details: JSON request**
@ -133,7 +133,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -142,5 +142,5 @@ Request
- port_id: port_id
Response
^^^^^^^^
--------

16
api-ref/source/os-keypairs.inc
View File

@ -19,14 +19,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Keypairs: JSON request**
@ -46,7 +46,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -60,7 +60,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Or Import Keypair: JSON request**
@ -80,7 +80,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -88,7 +88,7 @@ Request
- keypair_name: keypair_name
Response
^^^^^^^^
--------
Show Keypair Details
====================
@ -103,7 +103,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -111,7 +111,7 @@ Request
- keypair_name: keypair_name
Response
^^^^^^^^
--------
**Example Show Keypair Details: JSON request**

4
api-ref/source/os-migrations.inc
View File

@ -21,14 +21,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Migrations: JSON request**

36
api-ref/source/os-networks.inc
View File

@ -26,7 +26,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -38,7 +38,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Network: JSON request**
@ -60,14 +60,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Networks: JSON request**
@ -89,7 +89,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -101,7 +101,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Show Network Details
====================
@ -118,7 +118,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -126,7 +126,7 @@ Request
- network_id: network_id
Response
^^^^^^^^
--------
**Example Show Network Details: JSON request**
@ -148,7 +148,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -156,7 +156,7 @@ Request
- network_id: network_id
Response
^^^^^^^^
--------
Associate Host
==============
@ -173,7 +173,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -186,7 +186,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Disassociate Host
=================
@ -203,7 +203,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -216,7 +216,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Disassociate Network
====================
@ -233,7 +233,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -246,7 +246,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Disassociate Project
====================
@ -263,7 +263,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -276,5 +276,5 @@ Request
:language: javascript
Response
^^^^^^^^
--------

16
api-ref/source/os-quota-sets.inc
View File

@ -27,7 +27,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -64,7 +64,7 @@ Query Parameters
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -105,7 +105,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -120,7 +120,7 @@ Query Parameters
- user_id: user_id
Response
^^^^^^^^
--------
Show A Quota
============
@ -139,7 +139,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -147,7 +147,7 @@ Request
- tenant_id: tenant_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -188,7 +188,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -196,7 +196,7 @@ Request
- tenant_id: tenant_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml

16
api-ref/source/os-security-group-default-rules.inc
View File

@ -19,14 +19,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -57,7 +57,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -74,7 +74,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -103,7 +103,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -111,7 +111,7 @@ Request
- security_group_default_rule_id: security_group_default_rule_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -140,7 +140,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -148,5 +148,5 @@ Request
- security_group_default_rule_id: security_group_default_rule_id
Response
^^^^^^^^
--------

8
api-ref/source/os-security-group-rules.inc
View File

@ -19,7 +19,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -38,7 +38,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -71,7 +71,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -79,5 +79,5 @@ Request
- security_group_rule_id: security_group_rule_id
Response
^^^^^^^^
--------

24
api-ref/source/os-security-groups.inc
View File

@ -19,14 +19,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -55,7 +55,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -70,7 +70,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -99,7 +99,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -107,7 +107,7 @@ Request
- security_group_id: security_group_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -136,7 +136,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -151,7 +151,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -180,7 +180,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -188,7 +188,7 @@ Request
- security_group_id: security_group_id
Response
^^^^^^^^
--------
List Security Groups By Server
==============================
@ -203,7 +203,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -211,7 +211,7 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml

4
api-ref/source/os-server-external-events.inc
View File

@ -22,7 +22,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -39,7 +39,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml

16
api-ref/source/os-server-groups.inc
View File

@ -21,7 +21,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -35,7 +35,7 @@ Query Parameters
- all_projects: all_projects
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -66,7 +66,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -80,7 +80,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -111,7 +111,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -119,7 +119,7 @@ Request
- server_group_id: server_group_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -150,7 +150,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -158,5 +158,5 @@ Request
- server_group_id: server_group_id
Response
^^^^^^^^
--------

8
api-ref/source/os-server-password.inc
View File

@ -25,7 +25,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -33,7 +33,7 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------
**Example Show Server Password: JSON request**
@ -57,7 +57,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -65,5 +65,5 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------

20
api-ref/source/os-services.inc
View File

@ -26,14 +26,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -68,7 +68,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -82,7 +82,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -111,7 +111,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -125,7 +125,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -154,7 +154,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -169,7 +169,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -199,7 +199,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -214,5 +214,5 @@ Request
:language: javascript
Response
^^^^^^^^
--------

8
api-ref/source/os-simple-tenant-usage.inc
View File

@ -19,14 +19,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Tenant Usage For All Tenants: JSON request**
@ -46,14 +46,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example Show Usage Details For Tenant: JSON request**

32
api-ref/source/os-tenant-network.inc
View File

@ -21,7 +21,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -33,7 +33,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Project Network: JSON request**
@ -55,14 +55,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Project Networks: JSON request**
@ -84,7 +84,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -92,7 +92,7 @@ Request
- network_id: network_id
Response
^^^^^^^^
--------
**Example Show Project Network Details: JSON request**
@ -114,7 +114,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -122,7 +122,7 @@ Request
- network_id: network_id
Response
^^^^^^^^
--------
Associate Host
==============
@ -139,7 +139,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -152,7 +152,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Disassociate Host
=================
@ -169,7 +169,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -182,7 +182,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Disassociate Network
====================
@ -199,7 +199,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -212,7 +212,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Disassociate Project
====================
@ -229,7 +229,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -242,5 +242,5 @@ Request
:language: javascript
Response
^^^^^^^^
--------

4
api-ref/source/os-virtual-interfaces.inc
View File

@ -27,7 +27,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -35,7 +35,7 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml

48
api-ref/source/os-volumes.inc
View File

@ -19,14 +19,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Volumes: JSON request**
@ -46,7 +46,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -66,7 +66,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Volume: JSON request**
@ -86,14 +86,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Volumes With Details: JSON request**
@ -113,7 +113,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -121,7 +121,7 @@ Request
- volume_id: volume_id
Response
^^^^^^^^
--------
**Example Show Volume Details: JSON request**
@ -141,7 +141,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -149,7 +149,7 @@ Request
- volume_id: volume_id
Response
^^^^^^^^
--------
**Example Delete Volume: JSON request**
@ -169,14 +169,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -203,7 +203,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -211,7 +211,7 @@ Request
- volume_type_id: volume_type_id
Response
^^^^^^^^
--------
**Example Show Volume Type Details: JSON request**
@ -231,7 +231,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -244,7 +244,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Create Snapshot: JSON request**
@ -264,14 +264,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Snapshots: JSON request**
@ -291,14 +291,14 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
--------
**Example List Snapshots With Details: JSON request**
@ -318,7 +318,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -326,7 +326,7 @@ Request
- snapshot_id: snapshot_id
Response
^^^^^^^^
--------
**Example Show Snapshot Details: JSON request**
@ -348,7 +348,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -356,7 +356,7 @@ Request
- snapshot_id: snapshot_id
Response
^^^^^^^^
--------
**Example Delete Snapshot: JSON request**

4
api-ref/source/servers-action-console-output.inc
View File

@ -15,7 +15,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -30,7 +30,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Get console output: JSON response**

4
api-ref/source/servers-action-crash-dump.inc
View File

@ -19,7 +19,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -33,5 +33,5 @@ Request
:language: javascript
Response
^^^^^^^^
--------

8
api-ref/source/servers-action-deferred-delete.inc
View File

@ -17,7 +17,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -31,7 +31,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Restore Soft-Deleted Instance (Restore Action)
==============================================
@ -50,7 +50,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -64,5 +64,5 @@ Request
:language: javascript
Response
^^^^^^^^
--------

4
api-ref/source/servers-action-evacuate.inc
View File

@ -15,7 +15,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -31,7 +31,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Evacuate Server (Evacuate Action): JSON request**

8
api-ref/source/servers-action-fixed-ip.inc
View File

@ -17,7 +17,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -31,7 +31,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Remove (Disassociate) Fixed Ip (Removefixedip Action)
=====================================================
@ -50,7 +50,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -64,5 +64,5 @@ Request
:language: javascript
Response
^^^^^^^^
--------

16
api-ref/source/servers-action-remote-consoles.inc
View File

@ -15,7 +15,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -29,7 +29,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Get Rdp Console (Os-Getrdpconsole Action): JSON request**
@ -51,7 +51,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -65,7 +65,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Get Serial Console (Os-Getserialconsole Action): JSON request**
@ -87,7 +87,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -101,7 +101,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Get Spice Console (Os-Getspiceconsole Action): JSON request**
@ -123,7 +123,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -137,7 +137,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Get Vnc Console (Os-Getvncconsole Action): JSON request**

12
api-ref/source/servers-action-shelve.inc
View File

@ -35,7 +35,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -49,7 +49,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Shelf-Offload (Remove) Server (Shelveoffload Action)
====================================================
@ -84,7 +84,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -98,7 +98,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Unshelve (Restore) Shelved Server (Unshelve Action)
===================================================
@ -133,7 +133,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -147,5 +147,5 @@ Request
:language: javascript
Response
^^^^^^^^
--------

84
api-ref/source/servers-actions.inc
View File

@ -45,7 +45,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -61,7 +61,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Add Security Group To A Server (Addsecuritygroup Action)
========================================================
@ -78,7 +78,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -93,7 +93,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Change Administrative Password (Changepassword Action)
======================================================
@ -112,7 +112,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -126,7 +126,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Confirm Resized Server (Confirmresize Action)
=============================================
@ -155,7 +155,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -169,7 +169,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Create Image (Createimage Action)
=================================
@ -206,7 +206,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -220,7 +220,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Lock Server (Lock Action)
=========================
@ -239,7 +239,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -253,7 +253,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Pause Server (Pause Action)
===========================
@ -272,7 +272,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -286,7 +286,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Reboot Server (Reboot Action)
=============================
@ -303,7 +303,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -317,7 +317,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Rebuild Server (Rebuild Action)
===============================
@ -336,7 +336,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -356,7 +356,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
**Example Rebuild Server (Rebuild Action): JSON request**
@ -380,7 +380,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -395,7 +395,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Remove Security Group From A Server (Removesecuritygroup Action)
================================================================
@ -412,7 +412,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -427,7 +427,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Rescue Server (Rescue Action)
=============================
@ -450,7 +450,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -466,7 +466,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -500,7 +500,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -514,7 +514,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Resume Suspended Server (Resume Action)
=======================================
@ -533,7 +533,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -547,7 +547,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Revert Resized Server (Revertresize Action)
===========================================
@ -578,7 +578,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -592,7 +592,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Start Server (Os-Start Action)
==============================
@ -623,7 +623,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -637,7 +637,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Stop Server (Os-Stop Action)
============================
@ -664,7 +664,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -678,7 +678,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Suspend Server (Suspend Action)
===============================
@ -697,7 +697,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -711,7 +711,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Unlock Server (Unlock Action)
=============================
@ -730,7 +730,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -744,7 +744,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Unpause Server (Unpause Action)
===============================
@ -763,7 +763,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -777,7 +777,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Unrescue Server (Unrescue Action)
=================================
@ -804,7 +804,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -818,5 +818,5 @@ Request
:language: javascript
Response
^^^^^^^^
--------

24
api-ref/source/servers-admin-action.inc
View File

@ -30,7 +30,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -44,7 +44,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Inject Network Information (Injectnetworkinfo Action)
=====================================================
@ -63,7 +63,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -77,7 +77,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Migrate Server (Migrate Action)
===============================
@ -96,7 +96,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -110,7 +110,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Live-Migrate Server (Os-Migratelive Action)
===========================================
@ -131,7 +131,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -147,7 +147,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Reset Networking On A Server (Resetnetwork Action)
==================================================
@ -166,7 +166,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -180,7 +180,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
Reset Server State (Os-Resetstate Action)
=========================================
@ -199,7 +199,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -213,5 +213,5 @@ Request
:language: javascript
Response
^^^^^^^^
--------

8
api-ref/source/servers-multiple-create.inc
View File

@ -24,7 +24,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -61,7 +61,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -92,7 +92,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -129,7 +129,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml

20
api-ref/source/servers.inc
View File

@ -138,7 +138,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -174,7 +174,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -241,7 +241,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -262,7 +262,7 @@ Query Parameters
- marker: marker
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -303,7 +303,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -311,7 +311,7 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -373,7 +373,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -420,7 +420,7 @@ Request
:language: javascript
Response
^^^^^^^^
--------
.. rest_parameters:: parameters.yaml
@ -502,7 +502,7 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
.. rest_parameters:: parameters.yaml
@ -510,5 +510,5 @@ Request
- server_id: server_id
Response
^^^^^^^^
--------

12
api-ref/source/versions.inc
View File

@ -19,10 +19,10 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
Response
^^^^^^^^
--------
**Example List Api Versions: JSON request**
@ -42,10 +42,10 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
Response
^^^^^^^^
--------
**Example Show Api V2.1: JSON request**
@ -65,10 +65,10 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
-------
Response
^^^^^^^^
--------
**Example Show Api V2: JSON request**