summaryrefslogtreecommitdiff
path: root/api-ref/source/servers-admin-action.inc
diff options
context:
space:
mode:
authorMatt Riedemann <mriedem.os@gmail.com>2017-04-03 18:04:31 -0400
committerMatt Riedemann <mriedem.os@gmail.com>2017-04-10 16:24:28 -0400
commitb98d9e1d4f31417d277b996899aebfe758a9f40a (patch)
tree258816f8d9f7ab9f7fc43b0397566209c080654d /api-ref/source/servers-admin-action.inc
parent496bfb6287486f1c36249f18bd35cc4aa459f351 (diff)
downloadnova-b98d9e1d4f31417d277b996899aebfe758a9f40a.tar.gz
Document and provide useful error message for volume-backed backup
The createBackup API does not support backing up volume-backed instances. The error message the user gets is not useful about why the request was invalid, and the API reference docs do not mention the limitation. This change addresses both of those issues. Change-Id: I04fd8ab4f8818d9d0ccccb6f6fcb34965b15b8f3 Partial-Bug: #1679314
Diffstat (limited to 'api-ref/source/servers-admin-action.inc')
-rw-r--r--api-ref/source/servers-admin-action.inc2
1 files changed, 2 insertions, 0 deletions
diff --git a/api-ref/source/servers-admin-action.inc b/api-ref/source/servers-admin-action.inc
index 1110a49104..d69ba6b50e 100644
--- a/api-ref/source/servers-admin-action.inc
+++ b/api-ref/source/servers-admin-action.inc
@@ -20,6 +20,8 @@ Create Server Back Up (createBackup 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