896062a383
verified the API doc for os-instance-actions, changes some wording and the title, Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: Icaf84d86c773ad4173c662dc148219b3aba4a9fc
74 lines
1.8 KiB
ReStructuredText
74 lines
1.8 KiB
ReStructuredText
.. -*- rst -*-
|
|
.. needs:parameter_verification
|
|
.. needs:example_verification
|
|
.. needs:body_verification
|
|
|
|
================================================
|
|
Servers actions (servers, os-instance-actions)
|
|
================================================
|
|
|
|
All users can list available actions for a server.
|
|
|
|
List Actions For Server
|
|
=======================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-instance-actions
|
|
|
|
Lists actions for a server.
|
|
|
|
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.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), 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.
|
|
|
|
Policy defaults enable only users with the administrative role to perform this operation.
|
|
Cloud providers can change these permissions through the ``policy.json`` file.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), 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
|
|
|