703839142d
verify the parameters of servers-action-deferred-delete.inc including response and request. Part of bp:api-ref-in-rst Change-Id: Ie91e80c6c8a66095c56b7ccb5bdf6b6e4e4ddc64
77 lines
2.0 KiB
ReStructuredText
77 lines
2.0 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Force-Delete Server (forceDelete Action)
|
|
========================================
|
|
|
|
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
|
|
|
|
Force-deletes a server before deferred cleanup.
|
|
|
|
Specify the ``forceDelete`` 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.
|
|
|
|
Normal response codes: 202
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
|
|
conflict(409)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- server_id: server_id_path
|
|
- forceDelete: forceDelete
|
|
|
|
**Example Force-Delete Server (forceDelete Action): JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-deferred-delete/force-delete-post-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
No body is returned on a successful submission.
|
|
|
|
Restore Soft-Deleted Instance (restore Action)
|
|
==============================================
|
|
|
|
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
|
|
|
|
Restores a previously soft-deleted server instance. You cannot use
|
|
this method to restore deleted instances.
|
|
|
|
Specify the ``restore`` 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.
|
|
|
|
Normal response codes: 202
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
|
|
conflict(409)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- server_id: server_id_path
|
|
- restore: restore
|
|
|
|
**Example Restore Soft-Deleted Instance (restore Action): JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-deferred-delete/restore-post-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
No body is returned on a successful submission.
|