summaryrefslogtreecommitdiff
path: root/api-ref/source/os-instance-actions.inc
diff options
context:
space:
mode:
authorKevin_Zheng <zhengzhenyu@huawei.com>2016-06-07 17:24:27 +0800
committerYikun Jiang (Kero) <yikunkero@gmail.com>2017-12-14 07:42:17 +0000
commit0c480d795f850b1eb940508823d68f67708bde90 (patch)
tree40cb566d9be64ad2d761dd97d1b511ca5f88778e /api-ref/source/os-instance-actions.inc
parentd110ec59615d24e4a6528d41c0f3f73b7f93aa05 (diff)
downloadnova-0c480d795f850b1eb940508823d68f67708bde90.tar.gz
Add pagination and changes-since for instance-actions
This patch adds pagination support and changes-since filter for os-instance-actions API. Users can now use 'limit' and 'marker' to perform paginate query of instance action list. Users can also filter the results according to the actions' updated time. Co-Authored-By: Yikun Jiang <yikunkero@gmail.com> Implement: blueprint pagination-add-changes-since-for-instance-action-list Change-Id: I1a1b39803e8d0449f21d2ab5ef96d4060e638aa8
Diffstat (limited to 'api-ref/source/os-instance-actions.inc')
-rw-r--r--api-ref/source/os-instance-actions.inc12
1 files changed, 11 insertions, 1 deletions
diff --git a/api-ref/source/os-instance-actions.inc b/api-ref/source/os-instance-actions.inc
index c2ac18b5f7..2bb5b043e8 100644
--- a/api-ref/source/os-instance-actions.inc
+++ b/api-ref/source/os-instance-actions.inc
@@ -22,7 +22,7 @@ through the ``policy.json`` file.
Normal response codes: 200
-Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
+Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
@@ -31,6 +31,9 @@ Request
- server_id: server_id_path
+ - limit: instance_action_limit
+ - marker: instance_action_marker
+ - changes-since: changes_since_instance_action
Response
--------
@@ -46,12 +49,18 @@ Response
- request_id: request_id_body
- start_time: start_time
- user_id: user_id
+ - updated_at: updated_instance_action
+ - instance_actions_links: instance_actions_next_links
**Example List Actions For Server: JSON response**
.. literalinclude:: ../../doc/api_samples/os-instance-actions/instance-actions-list-resp.json
:language: javascript
+**Example List Actions For Server With Links (v2.58):**
+
+.. literalinclude:: ../../doc/api_samples/os-instance-actions/v2.58/instance-actions-list-with-limit-resp.json
+ :language: javascript
Show Server Action Details
==========================
@@ -102,6 +111,7 @@ Response
- events.finish_time: event_finish_time
- events.result: event_result
- events.traceback: event_traceback
+ - updated_at: updated_instance_action
**Example Show Server Action Details For Admin (v2.1)**