diff options
author | Takashi NATSUME <natsume.takashi@lab.ntt.co.jp> | 2018-12-05 04:23:08 +0000 |
---|---|---|
committer | Takashi NATSUME <natsume.takashi@lab.ntt.co.jp> | 2019-01-17 04:05:50 +0000 |
commit | 442c7c68c2c074591e96988059a63dd3c01e1ecd (patch) | |
tree | 501afa6d486b3d363e415e35e7c8ed6be9012f2a /api-guide/source | |
parent | e3b517b6fd7c470d5cee420fce1456b98495d310 (diff) | |
download | nova-442c7c68c2c074591e96988059a63dd3c01e1ecd.tar.gz |
api-ref: Body verification for the lock action
This patch adds more explanations for the lock action
in the Compute API reference and the Compute API guide.
Change-Id: Iae4a42351d11d5caade9a1a299b06fed862a7da4
Partial-Bug: #1793034
Diffstat (limited to 'api-guide/source')
-rw-r--r-- | api-guide/source/server_concepts.rst | 58 |
1 files changed, 53 insertions, 5 deletions
diff --git a/api-guide/source/server_concepts.rst b/api-guide/source/server_concepts.rst index f1c4222fda..aa6c600552 100644 --- a/api-guide/source/server_concepts.rst +++ b/api-guide/source/server_concepts.rst @@ -564,13 +564,61 @@ Server actions - **Lock**, **Unlock** - Lock a server so no further actions are allowed to the server. This can - be done by either administrator or the server's owner. By default, only owner - or administrator can lock the sever, and administrator can overwrite owner's lock. + Lock a server so the following actions by non-admin users are not + allowed to the server. + + - Delete Server + - Change Administrative Password (changePassword Action) + - Confirm Resized Server (confirmResize Action) + - Force-Delete Server (forceDelete Action) + - Pause Server (pause Action) + - Reboot Server (reboot Action) + - Rebuild Server (rebuild Action) + - Rescue Server (rescue Action) + - Resize Server (resize Action) + - Restore Soft-Deleted Instance (restore Action) + - Resume Suspended Server (resume Action) + - Revert Resized Server (revertResize Action) + - Shelf-Offload (Remove) Server (shelveOffload Action) + - Shelve Server (shelve Action) + - Start Server (os-start Action) + - Stop Server (os-stop Action) + - Suspend Server (suspend Action) + - Trigger Crash Dump In Server + - Unpause Server (unpause Action) + - Unrescue Server (unrescue Action) + - Unshelve (Restore) Shelved Server (unshelve Action) + - Attach a volume to an instance + - Update a volume attachment + - Detach a volume from an instance + - Create Interface + - Detach Interface + - Create Or Update Metadata Item + - Create or Update Metadata Items + - Delete Metadata Item + - Replace Metadata Items + - Add (Associate) Fixed Ip (addFixedIp Action) (DEPRECATED) + - Remove (Disassociate) Fixed Ip (removeFixedIp Action) (DEPRECATED) + + .. + NOTE(takashin): + The following APIs can be performed by administrators only by default. + So they are not listed in the above list. + + - Migrate Server (migrate Action) + - Live-Migrate Server (os-migrateLive Action) + - Force Migration Complete Action (force_complete Action) + - Delete (Abort) Migration + - Inject Network Information (injectNetworkInfo Action) + - Reset Networking On A Server (resetNetwork Action) + + But administrators can perform the actions on the server + even though the server is locked. By default, only owner or administrator + can lock the sever, and administrator can overwrite owner's lock. Unlock will unlock a server in locked state so additional - operations can be performed on the server. By default, only owner or - administrator can unlock the server. + operations can be performed on the server by non-admin users. + By default, only owner or administrator can unlock the server. - **Rescue**, **Unrescue** |