diff options
author | Andrew Laski <andrew.laski@rackspace.com> | 2012-12-12 10:35:11 -0500 |
---|---|---|
committer | Andrew Laski <andrew.laski@rackspace.com> | 2013-02-13 14:53:43 -0500 |
commit | 9ed8d398c2232722c44ca06ea545f679d4514d43 (patch) | |
tree | de4c904d49f537ce2f8982b296461b342479b84b /doc | |
parent | 787e334a105c47bb387dc51c8798b4ac8e1d7bc0 (diff) | |
download | nova-9ed8d398c2232722c44ca06ea545f679d4514d43.tar.gz nova-9ed8d398c2232722c44ca06ea545f679d4514d43.tar.xz nova-9ed8d398c2232722c44ca06ea545f679d4514d43.zip |
API extension for accessing instance_actions
Adds a new API extension for accessing the recorded actions and events
on an instance. Usage is documented with api samples.
Additionally it modified the db api to retrieve actions by request_id
since the api does not return the db id. This extension is the first
consumer of that method so there's no issue of changing behaviour
elsewhere.
Blueprint instance-actions
DocImpact
Change-Id: I74109586cc762a7f51d2b114896cf071ee0671cb
Diffstat (limited to 'doc')
6 files changed, 70 insertions, 0 deletions
diff --git a/doc/api_samples/all_extensions/extensions-get-resp.json b/doc/api_samples/all_extensions/extensions-get-resp.json index e83fc566f..ba5e410eb 100644 --- a/doc/api_samples/all_extensions/extensions-get-resp.json +++ b/doc/api_samples/all_extensions/extensions-get-resp.json @@ -313,6 +313,14 @@ "updated": "2012-06-21T00:00:00+00:00" }, { + "alias": "os-instance-actions", + "description": "View a log of actions taken on an instance", + "links": [], + "name": "InstanceActions", + "namespace": "http://docs.openstack.org/compute/ext/instance-actions/api/v1.1", + "updated": "2013-02-08T00:00:00+00:00" + }, + { "alias": "os-instance_usage_audit_log", "description": "Admin-only Task Log Monitoring.", "links": [], diff --git a/doc/api_samples/all_extensions/extensions-get-resp.xml b/doc/api_samples/all_extensions/extensions-get-resp.xml index 0bd86e609..a18e52437 100644 --- a/doc/api_samples/all_extensions/extensions-get-resp.xml +++ b/doc/api_samples/all_extensions/extensions-get-resp.xml @@ -135,6 +135,9 @@ <extension alias="os-hypervisors" updated="2012-06-21T00:00:00+00:00" namespace="http://docs.openstack.org/compute/ext/hypervisors/api/v1.1" name="Hypervisors"> <description>Admin-only hypervisor administration.</description> </extension> + <extension alias="os-instance-actions" updated="2013-02-08T00:00:00+00:00" namespace="http://docs.openstack.org/compute/ext/instance-actions/api/v1.1" name="InstanceActions"> + <description>View a log of actions taken on an instance</description> + </extension> <extension alias="os-instance_usage_audit_log" updated="2012-07-06T01:00:00+00:00" namespace="http://docs.openstack.org/ext/services/api/v1.1" name="OSInstanceUsageAuditLog"> <description>Admin-only Task Log Monitoring.</description> </extension> diff --git a/doc/api_samples/os-instance-actions/instance-action-get-resp.json b/doc/api_samples/os-instance-actions/instance-action-get-resp.json new file mode 100644 index 000000000..d5a2ff96c --- /dev/null +++ b/doc/api_samples/os-instance-actions/instance-action-get-resp.json @@ -0,0 +1,27 @@ +{ + "instanceAction": { + "action": "reboot", + "events": [ + { + "event": "schedule", + "finish_time": "2012-12-05 01:02:00.000000", + "result": "Success", + "start_time": "2012-12-05 01:00:02.000000", + "traceback": "" + }, + { + "event": "compute_create", + "finish_time": "2012-12-05 01:04:00.000000", + "result": "Success", + "start_time": "2012-12-05 01:03:00.000000", + "traceback": "" + } + ], + "instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13", + "message": "", + "project_id": "147", + "request_id": "req-3293a3f1-b44c-4609-b8d2-d81b105636b8", + "start_time": "2012-12-05 00:00:00.000000", + "user_id": "789" + } +}
\ No newline at end of file diff --git a/doc/api_samples/os-instance-actions/instance-action-get-resp.xml b/doc/api_samples/os-instance-actions/instance-action-get-resp.xml new file mode 100644 index 000000000..720cdd39a --- /dev/null +++ b/doc/api_samples/os-instance-actions/instance-action-get-resp.xml @@ -0,0 +1,5 @@ +<?xml version='1.0' encoding='UTF-8'?> +<instanceAction instance_uuid="b48316c5-71e8-45e4-9884-6c78055b9b13" user_id="789" start_time="2012-12-05 00:00:00.000000" request_id="req-3293a3f1-b44c-4609-b8d2-d81b105636b8" action="reboot" message="" project_id="147"> + <events finish_time="2012-12-05 01:02:00.000000" start_time="2012-12-05 01:00:02.000000" traceback="" event="schedule" result="Success"/> + <events finish_time="2012-12-05 01:04:00.000000" start_time="2012-12-05 01:03:00.000000" traceback="" event="compute_create" result="Success"/> +</instanceAction>
\ No newline at end of file diff --git a/doc/api_samples/os-instance-actions/instance-actions-list-resp.json b/doc/api_samples/os-instance-actions/instance-actions-list-resp.json new file mode 100644 index 000000000..22d29d076 --- /dev/null +++ b/doc/api_samples/os-instance-actions/instance-actions-list-resp.json @@ -0,0 +1,22 @@ +{ + "instanceActions": [ + { + "action": "resize", + "instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13", + "message": "", + "project_id": "842", + "request_id": "req-25517360-b757-47d3-be45-0e8d2a01b36a", + "start_time": "2012-12-05 01:00:00.000000", + "user_id": "789" + }, + { + "action": "reboot", + "instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13", + "message": "", + "project_id": "147", + "request_id": "req-3293a3f1-b44c-4609-b8d2-d81b105636b8", + "start_time": "2012-12-05 00:00:00.000000", + "user_id": "789" + } + ] +}
\ No newline at end of file diff --git a/doc/api_samples/os-instance-actions/instance-actions-list-resp.xml b/doc/api_samples/os-instance-actions/instance-actions-list-resp.xml new file mode 100644 index 000000000..33896df91 --- /dev/null +++ b/doc/api_samples/os-instance-actions/instance-actions-list-resp.xml @@ -0,0 +1,5 @@ +<?xml version='1.0' encoding='UTF-8'?> +<instanceActions> + <instanceAction instance_uuid="b48316c5-71e8-45e4-9884-6c78055b9b13" user_id="789" start_time="2012-12-05 01:00:00.000000" request_id="req-25517360-b757-47d3-be45-0e8d2a01b36a" action="resize" message="" project_id="842"/> + <instanceAction instance_uuid="b48316c5-71e8-45e4-9884-6c78055b9b13" user_id="789" start_time="2012-12-05 00:00:00.000000" request_id="req-3293a3f1-b44c-4609-b8d2-d81b105636b8" action="reboot" message="" project_id="147"/> +</instanceActions>
\ No newline at end of file |