nova/api-ref/source/os-server-password.inc
jichenjc fa89d6bfe5 Complete Verification of os-server-password
verified the API doc for os-server-password,
remove some common error code like 500, 503

etc Part of bp:api-ref-in-rst

Change-Id: Iab9f712fbf09bc141276fa32865b8b5b72de73be
2016-04-24 18:52:09 +08:00

71 lines
2.0 KiB
ReStructuredText

.. -*- rst -*-
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
================================================
Servers password (servers, os-server-password)
================================================
Shows the encrypted administrative password. Also, clears the encrypted
administrative password for a server, which removes it from the metadata
server.
Show Server Password
====================
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-server-password
Shows the administrative password for a server.
This operation calls the metadata service to query metadata information and does not read password information from the server itself.
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 Show Server Password: JSON response**
.. literalinclude:: ../../doc/api_samples/os-server-password/get-password-resp.json
:language: javascript
Clear Admin Password
====================
.. rest_method:: DELETE /v2.1/{tenant_id}/servers/{server_id}/os-server-password
Clears the encrypted administrative password for a server, which removes it from the metadata server.
This action does not actually change the instance server password.
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: 204
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id
Response
--------