Jump to: navigation, search

NovaServerActions

Revision as of 18:49, 26 October 2011 by GlenCampbell (talk)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Nova Server Actions

The API resource .../servers/{id}/action allows clients to POST a message to the server to take some specific action. These include REBOOT, SUSPEND, and various others. The problem is that client applications must know the available actions in order to send them.

To make it easier to develop clients, the new resource .../servers/{id}/actions returns an enumerated list of actions along with natural-language descriptions. Moreover, once security restrictions are in place, this resource can be enhanced to provide a list of only those actions to which the currently-authenticated user is authorized.

The only method permitted is GET.

This is an example return document:

<nova-server-actions>
   <action name="REBOOT" description="Reboot the server"/>
   <action name="SUSPEND" description="Suspend the server (make it inaccessible to the user)"/>
   ...
</nova-server-actions>

Clients only need to query this resource to gather a list of available actions; this could be used in a menu, help text, or simply to validate user input.