Merge "API Ref: update server_id params"
This commit is contained in:
commit
5d6a84b851
|
@ -26,8 +26,7 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
|
@ -27,7 +27,7 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- server_id: server_id
|
- server_id: server_id_path
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
@ -39,7 +39,7 @@ Response
|
||||||
- addr: ip_address
|
- addr: ip_address
|
||||||
- version: version_ip
|
- version: version_ip
|
||||||
|
|
||||||
**Example List Ips: JSON response**
|
**Example List Ips**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/server-ips/server-ips-resp.json
|
.. literalinclude:: ../../doc/api_samples/server-ips/server-ips-resp.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -64,7 +64,7 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- server_id: server_id
|
- server_id: server_id_path
|
||||||
- network_label: network_label
|
- network_label: network_label
|
||||||
|
|
||||||
Response
|
Response
|
||||||
|
@ -76,8 +76,7 @@ Response
|
||||||
- addr: ip_address
|
- addr: ip_address
|
||||||
- version: version_ip
|
- version: version_ip
|
||||||
|
|
||||||
**Example Show Ip Details: JSON response**
|
**Example Show Ip Details**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/server-ips/server-ips-network-resp.json
|
.. literalinclude:: ../../doc/api_samples/server-ips/server-ips-network-resp.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
|
@ -38,7 +38,7 @@ Response
|
||||||
|
|
||||||
- metadata: metadata_object
|
- metadata: metadata_object
|
||||||
|
|
||||||
**Example List All Metadata:**
|
**Example List All Metadata**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json
|
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -68,7 +68,7 @@ Request
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- metadata: metadata_object
|
- metadata: metadata_object
|
||||||
|
|
||||||
**Example Update Metadata Items:**
|
**Example Update Metadata Items**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-req.json
|
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -80,7 +80,7 @@ Response
|
||||||
|
|
||||||
- metadata: metadata_object
|
- metadata: metadata_object
|
||||||
|
|
||||||
**Example Update Metadata Items:**
|
**Example Update Metadata Items**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json
|
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -110,7 +110,7 @@ Request
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- metadata: metadata_object
|
- metadata: metadata_object
|
||||||
|
|
||||||
**Example Create Or Replace Metadata Items:**
|
**Example Create Or Replace Metadata Items**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-req.json
|
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -122,7 +122,7 @@ Response
|
||||||
|
|
||||||
- metadata: metadata_object
|
- metadata: metadata_object
|
||||||
|
|
||||||
**Example Create Or Replace Metadata Items:**
|
**Example Create Or Replace Metadata Items**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json
|
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -156,7 +156,7 @@ Response
|
||||||
|
|
||||||
- meta: metadata_object
|
- meta: metadata_object
|
||||||
|
|
||||||
**Example Show Metadata Item Details:**
|
**Example Show Metadata Item Details**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-resp.json
|
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-resp.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -186,7 +186,7 @@ Request
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- key: key
|
- key: key
|
||||||
|
|
||||||
**Example Create Or Update Metadata Item:**
|
**Example Create Or Update Metadata Item**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-req.json
|
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -198,7 +198,7 @@ Response
|
||||||
|
|
||||||
- meta: metadata_object
|
- meta: metadata_object
|
||||||
|
|
||||||
**Example Create Or Update Metadata Item:**
|
**Example Create Or Update Metadata Item**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-resp.json
|
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-resp.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -228,4 +228,4 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful DELETE action.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
|
@ -22,9 +22,7 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
|
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
@ -60,14 +58,12 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
|
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
No body content is returned on a successful POST.
|
If successful, this method does not return a response body.
|
||||||
|
|
||||||
|
|
||||||
Show Console Details
|
Show Console Details
|
||||||
|
@ -86,11 +82,9 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
- console_id: console_id
|
- console_id: console_id
|
||||||
|
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
@ -128,14 +122,14 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
- console_id: console_id
|
- console_id: console_id
|
||||||
|
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful DELETE query
|
If successful, this method does not return a response body.
|
||||||
|
|
||||||
|
|
||||||
Show Console Connection Information
|
Show Console Connection Information
|
||||||
|
|
|
@ -35,8 +35,7 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
@ -45,7 +44,7 @@ Response
|
||||||
|
|
||||||
- password: password
|
- password: password
|
||||||
|
|
||||||
**Example Show Server Password: JSON response**
|
**Example Show Server Password**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-server-password/get-password-resp.json
|
.. literalinclude:: ../../doc/api_samples/os-server-password/get-password-resp.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -73,10 +72,9 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful DELETE action.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
|
@ -221,8 +221,8 @@ Delete Compute Service
|
||||||
|
|
||||||
.. rest_method:: DELETE /os-services/{service_id}
|
.. rest_method:: DELETE /os-services/{service_id}
|
||||||
|
|
||||||
Deletes a Compute service. If it's a nova-compute service, then corresponding host will
|
Deletes a Compute service. If it's a nova-compute service, then the
|
||||||
removed from all the host aggregates as well.
|
corresponding host will be removed from all the host aggregates as well.
|
||||||
|
|
||||||
Normal response codes: 204
|
Normal response codes: 204
|
||||||
|
|
||||||
|
@ -233,10 +233,9 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- service_id: service_id_path
|
- service_id: service_id_path
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful DELETE query
|
If successful, this method does not return content in the response body.
|
||||||
|
|
|
@ -22,7 +22,7 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- server_id: server_id
|
- server_id: server_id_path
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
@ -37,7 +37,7 @@ Response
|
||||||
- tenant_id: tenant_id_body
|
- tenant_id: tenant_id_body
|
||||||
|
|
||||||
|
|
||||||
**Example List security groups by server: JSON response**
|
**Example List security groups by server**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-security-groups/server-security-groups-list-resp.json
|
.. literalinclude:: ../../doc/api_samples/os-security-groups/server-security-groups-list-resp.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
|
@ -1,15 +1,16 @@
|
||||||
.. -*- rst -*-
|
.. -*- rst -*-
|
||||||
|
|
||||||
Show Console Output (Os-Getconsoleoutput Action)
|
Show Console Output (os-getConsoleOutput Action)
|
||||||
================================================
|
================================================
|
||||||
|
|
||||||
.. rest_method:: POST /servers/{server_id}/action
|
.. rest_method:: POST /servers/{server_id}/action
|
||||||
|
|
||||||
Shows console output for a server instance.
|
Shows console output for a server instance.
|
||||||
|
|
||||||
This returns the text of the console since boot in a REST
|
This API returns the text of the console since boot.
|
||||||
response. The console content may be large, you can limit it with the
|
The content returned may be large. Limit the lines of console
|
||||||
optional ``length`` parameter.
|
text, beginning at the tail of the content, by setting
|
||||||
|
the optional ``length`` parameter in the request body.
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
|
|
||||||
|
@ -21,14 +22,14 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- os-getConsoleOutput: os-getConsoleOutput
|
- os-getConsoleOutput: os-getConsoleOutput
|
||||||
- length: length
|
- length: length
|
||||||
|
|
||||||
**Example Get console output**
|
**Example Show Console Output (os-getConsoleOutput Action)**
|
||||||
|
|
||||||
This requests the last 50 lines of the server in question.
|
This example requests the last 50 lines of console content
|
||||||
|
from the specified server.
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-console-output/console-output-post-req.json
|
.. literalinclude:: ../../doc/api_samples/os-console-output/console-output-post-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -40,7 +41,7 @@ Response
|
||||||
|
|
||||||
- output: console_output
|
- output: console_output
|
||||||
|
|
||||||
**Example Get console output: JSON response**
|
**Example Show Console Output (os-getConsoleOutput Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-console-output/console-output-post-resp.json
|
.. literalinclude:: ../../doc/api_samples/os-console-output/console-output-post-resp.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
|
@ -21,8 +21,7 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
- evacuate: evacuate
|
- evacuate: evacuate
|
||||||
- host: host
|
- host: host
|
||||||
- adminPass: adminPass_evacuate_rebuild_request
|
- adminPass: adminPass_evacuate_rebuild_request
|
||||||
|
@ -31,7 +30,7 @@ Request
|
||||||
|
|
||||||
|
|
|
|
||||||
|
|
||||||
**Example Evacuate Server (evacuate Action):**
|
**Example Evacuate Server (evacuate Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-req.json
|
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -46,7 +45,7 @@ Response
|
||||||
|
|
||||||
|
|
|
|
||||||
|
|
||||||
**Example Evacuate Server (evacuate Action):**
|
**Example Evacuate Server (evacuate Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-resp.json
|
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-resp.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
|
@ -27,11 +27,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
- addFixedIp: addFixedIp
|
- addFixedIp: addFixedIp
|
||||||
|
|
||||||
**Example Add (Associate) Fixed Ip (Addfixedip Action): JSON request**
|
**Example Add (Associate) Fixed Ip (Addfixedip Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-add-fixed-ip-req.json
|
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-add-fixed-ip-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -39,6 +38,7 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
|
||||||
Remove (Disassociate) Fixed Ip (Removefixedip Action)
|
Remove (Disassociate) Fixed Ip (Removefixedip Action)
|
||||||
=====================================================
|
=====================================================
|
||||||
|
|
||||||
|
@ -62,10 +62,10 @@ Request
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id
|
- server_id: server_id_path
|
||||||
- removeFixedIp: removeFixedIp
|
- removeFixedIp: removeFixedIp
|
||||||
|
|
||||||
**Example Remove (Disassociate) Fixed Ip (Removefixedip Action): JSON request**
|
**Example Remove (Disassociate) Fixed Ip (Removefixedip Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-remove-fixed-ip-req.json
|
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-remove-fixed-ip-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
|
@ -13,19 +13,19 @@ All associated data and resources are kept but anything still in memory is not r
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
Preconditions
|
**Preconditions**
|
||||||
|
|
||||||
The server status must be ``ACTIVE``, ``SHUTOFF``, ``PAUSED``, or ``SUSPENDED``.
|
The server status must be ``ACTIVE``, ``SHUTOFF``, ``PAUSED``, or ``SUSPENDED``.
|
||||||
|
|
||||||
If the server is locked, you must have administrator privileges to shelve the server.
|
If the server is locked, you must have administrator privileges to shelve the server.
|
||||||
|
|
||||||
Asynchronous Postconditions
|
**Asynchronous Postconditions**
|
||||||
|
|
||||||
After you successfully shelve a server, its status changes to ``SHELVED`` and the image status is ``ACTIVE``. The server instance data appears on the compute node that the Compute service manages.
|
After you successfully shelve a server, its status changes to ``SHELVED`` and the image status is ``ACTIVE``. The server instance data appears on the compute node that the Compute service manages.
|
||||||
|
|
||||||
If you boot the server from volumes or set the ``shelved_offload_time`` option to 0, the Compute service automatically deletes the instance on compute nodes and changes the server status to ``SHELVED_OFFLOADED``.
|
If you boot the server from volumes or set the ``shelved_offload_time`` option to 0, the Compute service automatically deletes the instance on compute nodes and changes the server status to ``SHELVED_OFFLOADED``.
|
||||||
|
|
||||||
Troubleshooting
|
**Troubleshooting**
|
||||||
|
|
||||||
If the server status does not change to ``SHELVED`` or ``SHELVED_OFFLOADED``, the shelve operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.
|
If the server status does not change to ``SHELVED`` or ``SHELVED_OFFLOADED``, the shelve operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.
|
||||||
|
|
||||||
|
@ -38,13 +38,12 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- shelve: shelve
|
- shelve: shelve
|
||||||
|
|
||||||
|
|
|
|
||||||
|
|
||||||
**Example Shelve server (shelve Action):**
|
**Example Shelve server (shelve Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-shelve/os-shelve.json
|
.. literalinclude:: ../../doc/api_samples/os-shelve/os-shelve.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -53,7 +52,7 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
No body is returned on successful request.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Shelf-Offload (Remove) Server (shelveOffload Action)
|
Shelf-Offload (Remove) Server (shelveOffload Action)
|
||||||
|
@ -69,17 +68,17 @@ Data and resource associations are deleted. If an instance is no longer needed,
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
Preconditions
|
**Preconditions**
|
||||||
|
|
||||||
The server status must be ``SHELVED``.
|
The server status must be ``SHELVED``.
|
||||||
|
|
||||||
If the server is locked, you must have administrator privileges to shelve-offload the server.
|
If the server is locked, you must have administrator privileges to shelve-offload the server.
|
||||||
|
|
||||||
Asynchronous Postconditions
|
**Asynchronous Postconditions**
|
||||||
|
|
||||||
After you successfully shelve-offload a server, its status changes to ``SHELVED_OFFLOADED``. The server instance data appears on the compute node.
|
After you successfully shelve-offload a server, its status changes to ``SHELVED_OFFLOADED``. The server instance data appears on the compute node.
|
||||||
|
|
||||||
Troubleshooting
|
**Troubleshooting**
|
||||||
|
|
||||||
If the server status does not change to ``SHELVED_OFFLOADED``, the shelve-offload operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.
|
If the server status does not change to ``SHELVED_OFFLOADED``, the shelve-offload operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.
|
||||||
|
|
||||||
|
@ -92,7 +91,6 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- shelveOffload: shelveOffload
|
- shelveOffload: shelveOffload
|
||||||
|
|
||||||
|
@ -107,7 +105,7 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
No body is returned on successful request.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Unshelve (Restore) Shelved Server (unshelve Action)
|
Unshelve (Restore) Shelved Server (unshelve Action)
|
||||||
|
@ -121,19 +119,19 @@ Specify the ``unshelve`` action in the request body.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
Preconditions
|
**Preconditions**
|
||||||
|
|
||||||
The server status must be ``SHELVED`` or ``SHELVED_OFFLOADED``.
|
The server status must be ``SHELVED`` or ``SHELVED_OFFLOADED``.
|
||||||
|
|
||||||
If the server is locked, you must have administrator privileges to unshelve the server.
|
If the server is locked, you must have administrator privileges to unshelve the server.
|
||||||
|
|
||||||
Asynchronous Postconditions
|
**Asynchronous Postconditions**
|
||||||
|
|
||||||
After you successfully shelve a server, its status changes to ``ACTIVE``. The server appears on the compute node.
|
After you successfully shelve a server, its status changes to ``ACTIVE``. The server appears on the compute node.
|
||||||
|
|
||||||
The shelved image is deleted from the list of images returned by an API call.
|
The shelved image is deleted from the list of images returned by an API call.
|
||||||
|
|
||||||
Troubleshooting
|
**Troubleshooting**
|
||||||
|
|
||||||
If the server status does not change to ``ACTIVE``, the unshelve operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.
|
If the server status does not change to ``ACTIVE``, the unshelve operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.
|
||||||
|
|
||||||
|
@ -146,13 +144,12 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- unshelve: unshelve
|
- unshelve: unshelve
|
||||||
|
|
||||||
|
|
|
|
||||||
|
|
||||||
**Example Unshelve server (unshelve Action):**
|
**Example Unshelve server (unshelve Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-shelve/os-unshelve.json
|
.. literalinclude:: ../../doc/api_samples/os-shelve/os-unshelve.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -161,4 +158,4 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
No body is returned on successful request.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
|
@ -45,7 +45,7 @@ If an instance is connected to multiple networks, you can associate a
|
||||||
floating IP address with a specific fixed IP address by using the
|
floating IP address with a specific fixed IP address by using the
|
||||||
optional ``fixed_address`` parameter.
|
optional ``fixed_address`` parameter.
|
||||||
|
|
||||||
Preconditions
|
**Preconditions**
|
||||||
|
|
||||||
The server must exist.
|
The server must exist.
|
||||||
|
|
||||||
|
@ -61,13 +61,12 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- addFloatingIp: addFloatingIp
|
- addFloatingIp: addFloatingIp
|
||||||
- address: address
|
- address: address
|
||||||
- fixed_address: fixed_address
|
- fixed_address: fixed_address
|
||||||
|
|
||||||
**Example Add (Associate) Floating Ip (addFloatingIp Action): JSON request**
|
**Example Add (Associate) Floating Ip (addFloatingIp Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/servers/server-action-addfloatingip.json
|
.. literalinclude:: ../../doc/api_samples/servers/server-action-addfloatingip.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -75,7 +74,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Add Security Group To A Server (addSecurityGroup Action)
|
Add Security Group To A Server (addSecurityGroup Action)
|
||||||
========================================================
|
========================================================
|
||||||
|
@ -96,12 +96,11 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- addSecurityGroup: addSecurityGroup
|
- addSecurityGroup: addSecurityGroup
|
||||||
- name: name
|
- name: name
|
||||||
|
|
||||||
**Example Add Security Group To A Server (addSecurityGroup Action): JSON request**
|
**Example Add Security Group To A Server (addSecurityGroup Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-add-post-req.json
|
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-add-post-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -109,7 +108,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Change Administrative Password (changePassword Action)
|
Change Administrative Password (changePassword Action)
|
||||||
======================================================
|
======================================================
|
||||||
|
@ -138,7 +138,7 @@ Request
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- changePassword: changePassword
|
- changePassword: changePassword
|
||||||
|
|
||||||
**Example Change Administrative Password (changePassword Action): JSON request**
|
**Example Change Administrative Password (changePassword Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-admin-password/admin-password-change-password.json
|
.. literalinclude:: ../../doc/api_samples/os-admin-password/admin-password-change-password.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -146,7 +146,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Confirm Resized Server (confirmResize Action)
|
Confirm Resized Server (confirmResize Action)
|
||||||
=============================================
|
=============================================
|
||||||
|
@ -163,7 +164,7 @@ confirming resize operation shows a status of ``ACTIVE`` or ``SHUTOFF``
|
||||||
and a migration_status of ``confirmed``. You can also see the resized
|
and a migration_status of ``confirmed``. You can also see the resized
|
||||||
server in the compute node that OpenStack Compute manages.
|
server in the compute node that OpenStack Compute manages.
|
||||||
|
|
||||||
Preconditions
|
**Preconditions**
|
||||||
|
|
||||||
You can only confirm the resized server where the status is
|
You can only confirm the resized server where the status is
|
||||||
``VERIFY_RESIZED``, the vm_status is ``RESIZED``, and the
|
``VERIFY_RESIZED``, the vm_status is ``RESIZED``, and the
|
||||||
|
@ -172,7 +173,7 @@ migration_status is ``finished`` or ``confirming``.
|
||||||
If the server is locked, you must have administrator privileges
|
If the server is locked, you must have administrator privileges
|
||||||
to confirm the server.
|
to confirm the server.
|
||||||
|
|
||||||
Troubleshooting
|
**Troubleshooting**
|
||||||
|
|
||||||
If the server status remains ``RESIZED``, the request failed. Ensure you
|
If the server status remains ``RESIZED``, the request failed. Ensure you
|
||||||
meet the preconditions and run the request again. If the request fails
|
meet the preconditions and run the request again. If the request fails
|
||||||
|
@ -188,11 +189,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- confirmResize: confirmResize
|
- confirmResize: confirmResize
|
||||||
|
|
||||||
**Example Confirm Resized Server (confirmResize Action): JSON request**
|
**Example Confirm Resized Server (confirmResize Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/servers/server-action-confirm-resize.json
|
.. literalinclude:: ../../doc/api_samples/servers/server-action-confirm-resize.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -200,7 +200,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Create Image (createImage Action)
|
Create Image (createImage Action)
|
||||||
=================================
|
=================================
|
||||||
|
@ -218,7 +219,7 @@ If the operation succeeds, the created image has a status of ``active`` and
|
||||||
the server status returns to the original status. You can also see the new
|
the server status returns to the original status. You can also see the new
|
||||||
image in the image back end that OpenStack Image service manages.
|
image in the image back end that OpenStack Image service manages.
|
||||||
|
|
||||||
Preconditions
|
**Preconditions**
|
||||||
|
|
||||||
The server must exist.
|
The server must exist.
|
||||||
|
|
||||||
|
@ -227,7 +228,7 @@ You can only create a new image from the server when its status is ``ACTIVE``,
|
||||||
|
|
||||||
The connection to the Image service is valid.
|
The connection to the Image service is valid.
|
||||||
|
|
||||||
Troubleshooting
|
**Troubleshooting**
|
||||||
|
|
||||||
If the image status remains uploading or shows another error status,
|
If the image status remains uploading or shows another error status,
|
||||||
the request failed. Ensure you meet the preconditions and run the request
|
the request failed. Ensure you meet the preconditions and run the request
|
||||||
|
@ -258,7 +259,7 @@ Request
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- createImage: createImage
|
- createImage: createImage
|
||||||
|
|
||||||
**Example Create Image (createImage Action): JSON request**
|
**Example Create Image (createImage Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/servers/server-action-create-image.json
|
.. literalinclude:: ../../doc/api_samples/servers/server-action-create-image.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -266,7 +267,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Lock Server (lock Action)
|
Lock Server (lock Action)
|
||||||
=========================
|
=========================
|
||||||
|
@ -294,7 +296,7 @@ Request
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- lock: lock
|
- lock: lock
|
||||||
|
|
||||||
**Example Lock Server (lock Action): JSON request**
|
**Example Lock Server (lock Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-lock-server/lock-server.json
|
.. literalinclude:: ../../doc/api_samples/os-lock-server/lock-server.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -302,7 +304,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Pause Server (pause Action)
|
Pause Server (pause Action)
|
||||||
===========================
|
===========================
|
||||||
|
@ -327,11 +330,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- pause: pause
|
- pause: pause
|
||||||
|
|
||||||
**Example Pause Server (pause Action): JSON request**
|
**Example Pause Server (pause Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-pause-server/pause-server.json
|
.. literalinclude:: ../../doc/api_samples/os-pause-server/pause-server.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -339,7 +341,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Reboot Server (reboot Action)
|
Reboot Server (reboot Action)
|
||||||
=============================
|
=============================
|
||||||
|
@ -360,11 +363,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- reboot: reboot
|
- reboot: reboot
|
||||||
|
|
||||||
**Example Reboot Server (reboot Action): JSON request**
|
**Example Reboot Server (reboot Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/servers/server-action-reboot.json
|
.. literalinclude:: ../../doc/api_samples/servers/server-action-reboot.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -372,7 +374,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Rebuild Server (rebuild Action)
|
Rebuild Server (rebuild Action)
|
||||||
===============================
|
===============================
|
||||||
|
@ -396,7 +399,6 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- rebuild: rebuild
|
- rebuild: rebuild
|
||||||
- imageRef: imageRef
|
- imageRef: imageRef
|
||||||
|
@ -406,7 +408,7 @@ Request
|
||||||
- personality: personality
|
- personality: personality
|
||||||
- preserve_ephemeral: preserve_ephemeral
|
- preserve_ephemeral: preserve_ephemeral
|
||||||
|
|
||||||
**Example Rebuild Server (rebuild Action): JSON request**
|
**Example Rebuild Server (rebuild Action)**
|
||||||
|
|
||||||
Preserving the ephemeral disk
|
Preserving the ephemeral disk
|
||||||
|
|
||||||
|
@ -416,7 +418,7 @@ Preserving the ephemeral disk
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
**Example Rebuild Server (rebuild Action): JSON response**
|
**Example Rebuild Server (rebuild Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/servers/server-action-rebuild-resp.json
|
.. literalinclude:: ../../doc/api_samples/servers/server-action-rebuild-resp.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -445,13 +447,12 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- removeFloatingIp: removeFloatingIp
|
- removeFloatingIp: removeFloatingIp
|
||||||
- address: address
|
- address: address
|
||||||
|
|
||||||
.. TODO(sdague) build example for this
|
.. TODO(sdague) build example for this
|
||||||
**Example Remove (Disassociate) Floating Ip (removeFloatingIp Action): JSON request**
|
**Example Remove (Disassociate) Floating Ip (removeFloatingIp Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/servers-action/removeFloatingIp-req.json
|
.. literalinclude:: ../../doc/api_samples/servers-action/removeFloatingIp-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -459,7 +460,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Remove Security Group From A Server (removeSecurityGroup Action)
|
Remove Security Group From A Server (removeSecurityGroup Action)
|
||||||
================================================================
|
================================================================
|
||||||
|
@ -480,12 +482,11 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- removeSecurityGroup: removeSecurityGroup
|
- removeSecurityGroup: removeSecurityGroup
|
||||||
- name: name
|
- name: name
|
||||||
|
|
||||||
**Example Remove Security Group From A Server (removeSecurityGroup Action): JSON request**
|
**Example Remove Security Group From A Server (removeSecurityGroup Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-remove-post-req.json
|
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-remove-post-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -493,7 +494,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Rescue Server (rescue Action)
|
Rescue Server (rescue Action)
|
||||||
=============================
|
=============================
|
||||||
|
@ -508,7 +510,7 @@ If you specify the ``rescue_image_ref`` extended attribute,
|
||||||
the image is used to rescue the instance. If you omit an image
|
the image is used to rescue the instance. If you omit an image
|
||||||
reference, the base image reference is used by default.
|
reference, the base image reference is used by default.
|
||||||
|
|
||||||
Asynchronous Postconditions
|
**Asynchronous Postconditions**
|
||||||
|
|
||||||
After you successfully rescue a server and make a ``GET
|
After you successfully rescue a server and make a ``GET
|
||||||
/servers/{server_id}`` request, its status changes to ``RESCUE``.
|
/servers/{server_id}`` request, its status changes to ``RESCUE``.
|
||||||
|
@ -523,13 +525,12 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- rescue: rescue
|
- rescue: rescue
|
||||||
- adminPass: adminPass_rescue
|
- adminPass: adminPass_rescue
|
||||||
- rescue_image_ref: rescue_image_ref
|
- rescue_image_ref: rescue_image_ref
|
||||||
|
|
||||||
**Example Rescue server: JSON request**
|
**Example Rescue server**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-rescue/server-rescue-req.json
|
.. literalinclude:: ../../doc/api_samples/os-rescue/server-rescue-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -541,7 +542,7 @@ Response
|
||||||
|
|
||||||
- adminPass: adminPass
|
- adminPass: adminPass
|
||||||
|
|
||||||
**Example Extended rescue server: JSON response**
|
**Example Extended rescue server**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-rescue/server-rescue.json
|
.. literalinclude:: ../../doc/api_samples/os-rescue/server-rescue.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -561,7 +562,7 @@ A successfully resized server shows a ``VERIFY_RESIZE`` status,
|
||||||
the Compute service automatically confirms the resize operation after
|
the Compute service automatically confirms the resize operation after
|
||||||
the set interval in seconds.
|
the set interval in seconds.
|
||||||
|
|
||||||
Preconditions
|
**Preconditions**
|
||||||
|
|
||||||
You can only resize a server when its status is ``ACTIVE`` or ``SHUTOFF``.
|
You can only resize a server when its status is ``ACTIVE`` or ``SHUTOFF``.
|
||||||
|
|
||||||
|
@ -578,11 +579,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- resize: resize
|
- resize: resize
|
||||||
|
|
||||||
**Example Resize Server (Resize Action): JSON request**
|
**Example Resize Server (Resize Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/servers/server-action-resize.json
|
.. literalinclude:: ../../doc/api_samples/servers/server-action-resize.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -590,7 +590,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Resume Suspended Server (resume Action)
|
Resume Suspended Server (resume Action)
|
||||||
=======================================
|
=======================================
|
||||||
|
@ -615,11 +616,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- resume: resume
|
- resume: resume
|
||||||
|
|
||||||
**Example Resume Suspended Server (Resume Action): JSON request**
|
**Example Resume Suspended Server (Resume Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-suspend-server/server-resume.json
|
.. literalinclude:: ../../doc/api_samples/os-suspend-server/server-resume.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -627,7 +627,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Revert Resized Server (revertResize Action)
|
Revert Resized Server (revertResize Action)
|
||||||
===========================================
|
===========================================
|
||||||
|
@ -638,7 +639,7 @@ Cancels and reverts a pending resize action for a server.
|
||||||
|
|
||||||
Specify the ``revertResize`` action in the request body.
|
Specify the ``revertResize`` action in the request body.
|
||||||
|
|
||||||
Preconditions
|
**Preconditions**
|
||||||
|
|
||||||
You can only revert the resized server where the status is
|
You can only revert the resized server where the status is
|
||||||
``VERIFY_RESIZE`` and the OS-EXT-STS:vm_state is ``resized``.
|
``VERIFY_RESIZE`` and the OS-EXT-STS:vm_state is ``resized``.
|
||||||
|
@ -646,7 +647,7 @@ You can only revert the resized server where the status is
|
||||||
If the server is locked, you must have administrator privileges to revert
|
If the server is locked, you must have administrator privileges to revert
|
||||||
the resizing.
|
the resizing.
|
||||||
|
|
||||||
Asynchronous Postconditions
|
**Asynchronous Postconditions**
|
||||||
|
|
||||||
After you make this request, you typically must keep polling the server status
|
After you make this request, you typically must keep polling the server status
|
||||||
to determine whether the request succeeded. A reverting resize operation shows
|
to determine whether the request succeeded. A reverting resize operation shows
|
||||||
|
@ -654,7 +655,7 @@ a status of ``REVERT_RESIZE`` and a task_state of ``resize_reverting``. If
|
||||||
successful, the status will return to ``ACTIVE`` or ``SHUTOFF``. You can also
|
successful, the status will return to ``ACTIVE`` or ``SHUTOFF``. You can also
|
||||||
see the reverted server in the compute node that OpenStack Compute manages.
|
see the reverted server in the compute node that OpenStack Compute manages.
|
||||||
|
|
||||||
Troubleshooting
|
**Troubleshooting**
|
||||||
|
|
||||||
If the server status remains ``VERIFY_RESIZE``, the request failed. Ensure you
|
If the server status remains ``VERIFY_RESIZE``, the request failed. Ensure you
|
||||||
meet the preconditions and run the request again. If the request fails again,
|
meet the preconditions and run the request again. If the request fails again,
|
||||||
|
@ -672,11 +673,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- revertResize: revertResize
|
- revertResize: revertResize
|
||||||
|
|
||||||
**Example Revert Resized Server (revertResize Action): JSON request**
|
**Example Revert Resized Server (revertResize Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/servers/server-action-revert-resize.json
|
.. literalinclude:: ../../doc/api_samples/servers/server-action-revert-resize.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -684,7 +684,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Start Server (os-start Action)
|
Start Server (os-start Action)
|
||||||
==============================
|
==============================
|
||||||
|
@ -695,19 +696,19 @@ Starts a stopped server and changes its status to ``ACTIVE``.
|
||||||
|
|
||||||
Specify the ``os-start`` action in the request body.
|
Specify the ``os-start`` action in the request body.
|
||||||
|
|
||||||
Preconditions
|
**Preconditions**
|
||||||
|
|
||||||
The server status must be ``SHUTOFF``.
|
The server status must be ``SHUTOFF``.
|
||||||
|
|
||||||
If the server is locked, you must have administrator privileges
|
If the server is locked, you must have administrator privileges
|
||||||
to start the server.
|
to start the server.
|
||||||
|
|
||||||
Asynchronous Postconditions
|
**Asynchronous Postconditions**
|
||||||
|
|
||||||
After you successfully start a server, its status changes to ``ACTIVE``.
|
After you successfully start a server, its status changes to ``ACTIVE``.
|
||||||
The server appears on the compute node that the Compute service manages.
|
The server appears on the compute node that the Compute service manages.
|
||||||
|
|
||||||
Troubleshooting
|
**Troubleshooting**
|
||||||
|
|
||||||
If the server status does not change to ``ACTIVE``, the start operation failed.
|
If the server status does not change to ``ACTIVE``, the start operation failed.
|
||||||
Ensure that you meet the preconditions and run the request again.
|
Ensure that you meet the preconditions and run the request again.
|
||||||
|
@ -724,11 +725,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- os-start: os-start
|
- os-start: os-start
|
||||||
|
|
||||||
**Example Start server: JSON request**
|
**Example Start server**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/servers/server-action-start.json
|
.. literalinclude:: ../../doc/api_samples/servers/server-action-start.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -736,7 +736,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Stop Server (os-stop Action)
|
Stop Server (os-stop Action)
|
||||||
============================
|
============================
|
||||||
|
@ -747,14 +748,14 @@ Stops a running server and changes its status to ``SHUTOFF``.
|
||||||
|
|
||||||
Specify the ``os-stop`` action in the request body.
|
Specify the ``os-stop`` action in the request body.
|
||||||
|
|
||||||
Preconditions
|
**Preconditions**
|
||||||
|
|
||||||
The server status must be ``ACTIVE`` or ``ERROR``.
|
The server status must be ``ACTIVE`` or ``ERROR``.
|
||||||
|
|
||||||
If the server is locked, you must have administrator privileges
|
If the server is locked, you must have administrator privileges
|
||||||
to stop the server.
|
to stop the server.
|
||||||
|
|
||||||
Asynchronous Postconditions
|
**Asynchronous Postconditions**
|
||||||
|
|
||||||
After you successfully stop a server, its status changes to ``SHUTOFF``.
|
After you successfully stop a server, its status changes to ``SHUTOFF``.
|
||||||
The server instance data appears only on the compute node that
|
The server instance data appears only on the compute node that
|
||||||
|
@ -770,11 +771,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- os-stop: os-stop
|
- os-stop: os-stop
|
||||||
|
|
||||||
**Example Stop server: JSON request**
|
**Example Stop server**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/servers/server-action-stop.json
|
.. literalinclude:: ../../doc/api_samples/servers/server-action-stop.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -782,7 +782,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Suspend Server (suspend Action)
|
Suspend Server (suspend Action)
|
||||||
===============================
|
===============================
|
||||||
|
@ -807,11 +808,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- suspend: suspend
|
- suspend: suspend
|
||||||
|
|
||||||
**Example Suspend Server (suspend Action): JSON request**
|
**Example Suspend Server (suspend Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-suspend-server/server-suspend.json
|
.. literalinclude:: ../../doc/api_samples/os-suspend-server/server-suspend.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -819,7 +819,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Unlock Server (unlock Action)
|
Unlock Server (unlock Action)
|
||||||
=============================
|
=============================
|
||||||
|
@ -843,11 +844,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- unlock: unlock
|
- unlock: unlock
|
||||||
|
|
||||||
**Example Unlock Server (unlock Action): JSON request**
|
**Example Unlock Server (unlock Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-lock-server/unlock-server.json
|
.. literalinclude:: ../../doc/api_samples/os-lock-server/unlock-server.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -855,7 +855,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Unpause Server (unpause Action)
|
Unpause Server (unpause Action)
|
||||||
===============================
|
===============================
|
||||||
|
@ -884,7 +885,7 @@ Request
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- unpause: unpause
|
- unpause: unpause
|
||||||
|
|
||||||
**Example Unpause Server (unpause Action): JSON request**
|
**Example Unpause Server (unpause Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-pause-server/unpause-server.json
|
.. literalinclude:: ../../doc/api_samples/os-pause-server/unpause-server.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -892,7 +893,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Unrescue Server (unrescue Action)
|
Unrescue Server (unrescue Action)
|
||||||
=================================
|
=================================
|
||||||
|
@ -903,13 +905,13 @@ Unrescues a server. Changes status to ``ACTIVE``.
|
||||||
|
|
||||||
Specify the ``unrescue`` action in the request body.
|
Specify the ``unrescue`` action in the request body.
|
||||||
|
|
||||||
Preconditions
|
**Preconditions**
|
||||||
|
|
||||||
The server must exist.
|
The server must exist.
|
||||||
|
|
||||||
You can only unrescue a server when its status is ``RESCUE``.
|
You can only unrescue a server when its status is ``RESCUE``.
|
||||||
|
|
||||||
Asynchronous Postconditions
|
**Asynchronous Postconditions**
|
||||||
|
|
||||||
After you successfully unrescue a server and make a
|
After you successfully unrescue a server and make a
|
||||||
``GET /servers/{server_id}``
|
``GET /servers/{server_id}``
|
||||||
|
@ -925,11 +927,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
||||||
- server_id: server_id_path
|
- server_id: server_id_path
|
||||||
- unrescue: unrescue
|
- unrescue: unrescue
|
||||||
|
|
||||||
**Example Unrescue server: JSON request**
|
**Example Unrescue server**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-rescue/server-unrescue-req.json
|
.. literalinclude:: ../../doc/api_samples/os-rescue/server-unrescue-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -937,4 +938,4 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
There is no body content for the response of a successful POST operation.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
|
@ -36,15 +36,14 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
- createBackup: createBackup
|
- createBackup: createBackup
|
||||||
- name: backup_name
|
- name: backup_name
|
||||||
- backup_type: backup_type
|
- backup_type: backup_type
|
||||||
- rotation: backup_rotation
|
- rotation: backup_rotation
|
||||||
- metadata: metadata
|
- metadata: metadata
|
||||||
|
|
||||||
**Example Create Server Back Up (Createbackup Action): JSON request**
|
**Example Create Server Back Up (Createbackup Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-create-backup/create-backup-req.json
|
.. literalinclude:: ../../doc/api_samples/os-create-backup/create-backup-req.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -52,8 +51,9 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
On success a header 'Location' : <image location URL> and no body
|
If successful, the header 'Location' : <image location URL>
|
||||||
will be returned.
|
will be returned. No response body is returned.
|
||||||
|
|
||||||
|
|
||||||
Inject Network Information (injectNetworkInfo Action)
|
Inject Network Information (injectNetworkInfo Action)
|
||||||
=====================================================
|
=====================================================
|
||||||
|
@ -81,11 +81,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
- injectNetworkInfo: injectNetworkInfo
|
- injectNetworkInfo: injectNetworkInfo
|
||||||
|
|
||||||
**Example Inject Network Information (injectNetworkInfo Action): JSON request**
|
**Example Inject Network Information (injectNetworkInfo Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-admin-actions/admin-actions-inject-network-info.json
|
.. literalinclude:: ../../doc/api_samples/os-admin-actions/admin-actions-inject-network-info.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -93,7 +92,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
On success no body is returned.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Migrate Server (migrate Action)
|
Migrate Server (migrate Action)
|
||||||
===============================
|
===============================
|
||||||
|
@ -118,11 +118,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
- migrate: migrate
|
- migrate: migrate
|
||||||
|
|
||||||
**Example Migrate Server (migrate Action): JSON request**
|
**Example Migrate Server (migrate Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-migrate-server/migrate-server.json
|
.. literalinclude:: ../../doc/api_samples/os-migrate-server/migrate-server.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -130,7 +129,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
On success no body is returned.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Live-Migrate Server (os-migrateLive Action)
|
Live-Migrate Server (os-migrateLive Action)
|
||||||
===========================================
|
===========================================
|
||||||
|
@ -170,15 +170,14 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
- host: host_migration
|
- host: host_migration
|
||||||
- block_migration: block_migration
|
- block_migration: block_migration
|
||||||
- block_migration: block_migration_2_25
|
- block_migration: block_migration_2_25
|
||||||
- disk_over_commit: disk_over_commit
|
- disk_over_commit: disk_over_commit
|
||||||
- force: force_live_migrate
|
- force: force_live_migrate
|
||||||
|
|
||||||
**Example Live-Migrate Server (os-migrateLive Action): JSON request**
|
**Example Live-Migrate Server (os-migrateLive Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-migrate-server/v2.30/live-migrate-server.json
|
.. literalinclude:: ../../doc/api_samples/os-migrate-server/v2.30/live-migrate-server.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -186,7 +185,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
On success no body is returned.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Reset Networking On A Server (resetNetwork Action)
|
Reset Networking On A Server (resetNetwork Action)
|
||||||
==================================================
|
==================================================
|
||||||
|
@ -216,11 +216,10 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
- resetNetwork: resetNetwork
|
- resetNetwork: resetNetwork
|
||||||
|
|
||||||
**Example Reset Networking On A Server (resetNetwork Action): JSON request**
|
**Example Reset Networking On A Server (resetNetwork Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-admin-actions/admin-actions-reset-network.json
|
.. literalinclude:: ../../doc/api_samples/os-admin-actions/admin-actions-reset-network.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -228,7 +227,8 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
On success no body is returned.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
||||||
|
|
||||||
Reset Server State (os-resetState Action)
|
Reset Server State (os-resetState Action)
|
||||||
=========================================
|
=========================================
|
||||||
|
@ -252,12 +252,11 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- server_id: server_id_path
|
||||||
- server_id: server_id
|
|
||||||
- os-resetState: os-resetState
|
- os-resetState: os-resetState
|
||||||
- os-resetState.state: os-resetState_state
|
- os-resetState.state: os-resetState_state
|
||||||
|
|
||||||
**Example Reset Server State (os-resetState Action): JSON request**
|
**Example Reset Server State (os-resetState Action)**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-admin-actions/admin-actions-reset-server-state.json
|
.. literalinclude:: ../../doc/api_samples/os-admin-actions/admin-actions-reset-server-state.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
@ -265,4 +264,4 @@ Request
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
On success no body is returned.
|
If successful, this method does not return content in the response body.
|
||||||
|
|
Loading…
Reference in New Issue