Bug 1299980 - [RFE] Pagination and Filtering For Listing OpenStack Server Groups Using REST API
[RFE] Pagination and Filtering For Listing OpenStack Server Groups Using REST...
Product: Red Hat OpenStack
Classification: Red Hat
Component: openstack-nova (Show other bugs)
7.0 (Kilo)
All Linux
medium Severity medium
: ga
: 11.0 (Ocata)
Assigned To: Eoghan Glynn
: FutureFeature
Depends On:
  Show dependency treegraph
Reported: 2016-01-19 11:25 EST by Jack Waterworth
Modified: 2017-09-25 13:00 EDT (History)
14 users (show)

See Also:
Fixed In Version:
Doc Type: Enhancement
Doc Text:
Story Points: ---
Clone Of:
Last Closed: 2016-11-22 08:57:07 EST
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---

Attachments (Terms of Use)

External Trackers
Tracker ID Priority Status Summary Last Updated
Red Hat Knowledge Base (Solution) 1562523 None None None 2016-03-08 14:06 EST
OpenStack gerrit 400851 None None None 2016-11-22 12:58 EST

  None (edit)
Comment 2 Jack Waterworth 2016-01-19 11:26:49 EST
The issue isn't with the limit itself.  The issue is that regardless of what that limit is, if we have more entries than that number allows, we can't get all the results.

So, for example, say we have a limit of 500.  We do a RESP API call to retrieve a list of server groups so that we can run some logic with it.  If there are 750 entries, we only get 500 of those.  We could increase the limit to 1000, but that will only work as long as the number of server groups is below 1000.  If the number of server groups increases from 750 to 1500, we run across the same problem again.

Changing the limit is often times undesirable, because it changes the number of results returned for all queries, not just for server groups.

Filtering within the REST API would be a useful feature as well, since even with the case of pagination, there might be more information than we want to have to page through.

I attempted adding the url parameters in the format "http://<server>/v2/<tenant_id>/os-server-groups?limit=10&marker=<server_group_id>" .  The limit parameter appears to work, but not marker, so it doesn't appear that pagination is available.
Comment 7 Diana Clarke 2016-11-21 16:33:04 EST
The 'os-server-groups' endpoint uses 'limit' & 'offset' query parameters, not 'limit' & 'marker' query parameters.

For example, testing notes on devstack:


Can you give 'offset' a try and let me know if that doesn't work?
Comment 8 Diana Clarke 2016-11-22 08:57:07 EST
Marking this as closed since 'os-server-groups' paging has worked for a few years now (I'm not sure when it was first introduced).

I've added it to my TODO list to update the api-ref docs [1] to include the optional 'limit' and 'offset' query parameters.

This is the code [2] 'os-server-groups' is using to facilitate paging.

From that code: 'offset' is where to start in the list, and 'limit' is the maximum number of items to return. If 'limit' is not specified, 0, or > max_limit, we default to max_limit.

[1] http://developer.openstack.org/api-ref/compute/?expanded=list-server-groups-detail

[2] https://github.com/openstack/nova/blob/47ff843551cdaf5935ddf74647a1b81153975b21/nova/api/openstack/common.py#L217

Hope that helps, Cheers!

Note You need to log in before you can comment on or make changes to this bug.