summaryrefslogtreecommitdiff
path: root/api-ref/source/os-instance-actions.inc
blob: 6f0ee2e1c568de0c7df7018f16bc358ceed85cca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
.. -*- rst -*-

=======================================================
 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 request**

.. 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 request**

.. literalinclude:: ../../doc/api_samples/os-instance-actions/instance-action-show-resp.json
   :language: javascript