
This adds a set of tags in comments to the beginning of files so that we can process them according to the documentation here: https://wiki.openstack.org/wiki/NovaAPIRef Part of bp:api-ref-in-rst Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
73 lines
1.8 KiB
ReStructuredText
73 lines
1.8 KiB
ReStructuredText
.. -*- rst -*-
|
|
.. needs:method_verification
|
|
.. needs:parameter_verification
|
|
.. needs:example_verification
|
|
.. needs:body_verification
|
|
|
|
=======================================================
|
|
Servers - list actions (servers, os-instance-actions)
|
|
=======================================================
|
|
|
|
All users can list available actions for a server.
|
|
|
|
All users can show details for a server action; however, only
|
|
administrators can view server events in server action details.
|
|
|
|
List Actions For Server
|
|
=======================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-instance-actions
|
|
|
|
Lists actions for a server.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- server_id: server_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Actions For Server: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-instance-actions/instance-actions-list-resp.json
|
|
:language: javascript
|
|
|
|
Show Server Action Details
|
|
==========================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-instance-actions/{request_id}
|
|
|
|
Shows details for a server action.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- server_id: server_id
|
|
- request_id: request_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Show Server Action Details: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-instance-actions/instance-action-get-resp.json
|
|
:language: javascript
|
|
|