diff options
author | Matt Riedemann <mriedem.os@gmail.com> | 2017-04-25 12:05:48 -0400 |
---|---|---|
committer | Matt Riedemann <mriedem.os@gmail.com> | 2017-04-25 12:05:48 -0400 |
commit | 0a03f0123cccb9271d7a24f4cbb086eaba525f61 (patch) | |
tree | 257f0bc3dc20f8f445f41d06af37d3e7bcd7bec3 /api-ref/source/servers-actions.inc | |
parent | 03ce16988463c08761e9dbe90579792dcdf94c68 (diff) | |
download | nova-0a03f0123cccb9271d7a24f4cbb086eaba525f61.tar.gz |
api-ref: move createBackup to server-actions
The createBackup API is by default an admin-or-owner API, so it
should live in server-actions rather than server-admin-actions.
Change-Id: Ifdc08a1df39f30944d45e2001d590b34a963d062
Closes-Bug: #1679314
Diffstat (limited to 'api-ref/source/servers-actions.inc')
-rw-r--r-- | api-ref/source/servers-actions.inc | 54 |
1 files changed, 52 insertions, 2 deletions
diff --git a/api-ref/source/servers-actions.inc b/api-ref/source/servers-actions.inc index a4c56be00a..77382f2c8f 100644 --- a/api-ref/source/servers-actions.inc +++ b/api-ref/source/servers-actions.inc @@ -14,8 +14,9 @@ You can associate a fixed or floating IP address with a server, or disassociate a fixed or floating IP address from a server. You can attach a volume to a server. -You can create an image from a server, evacuate a server from a failed -host to a new host, and force-delete a server before deferred cleanup. +You can create an image from a server, create a backup of a server, +evacuate a server from a failed host to a new host, and force-delete a +server before deferred cleanup. You can lock, pause, reboot, rebuild, rescue, resize, resume, confirm the resize of, revert a pending resize for, shelve, shelf-offload, unshelve, start, stop, unlock, unpause, and unrescue a server. You can @@ -207,6 +208,55 @@ Response If successful, this method does not return content in the response body. +Create Server Back Up (createBackup Action) +=========================================== + +.. rest_method:: POST /servers/{server_id}/action + +Creates a back up of a server. + +.. note:: This API is not supported for volume-backed instances. + +Specify the ``createBackup`` 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. + +.. note:: + Starting from version 2.39 the image quota enforcement with Nova `metadata` + is removed and quota checks should be performed using Glance API directly. + +Normal response codes: 202 + +Error response codes: badRequest(400), unauthorized(401), forbidden(403), +itemNotFound(404), conflict(409) + +Request +------- + +.. rest_parameters:: parameters.yaml + + - server_id: server_id_path + - createBackup: createBackup + - name: backup_name + - backup_type: backup_type + - rotation: backup_rotation + - metadata: metadata + +**Example Create Server Back Up (Createbackup Action)** + +.. literalinclude:: ../../doc/api_samples/os-create-backup/create-backup-req.json + :language: javascript + +Response +-------- + +.. rest_parameters:: parameters.yaml + + - image_location: image_location + + Create Image (createImage Action) ================================= |