Paging support

Paging restricts the number of records returned by the server. For instance, a volume query request can return thousands of volume records. To enhance your control of received data, two parameters are available.

offset
This parameter sets where the list of resources starts, according to the index number of the resource.
  • If no offset is defined, the response contains the entire list of resources.
  • If an offset is greater than the total resources, the response is empty.
  • The index number of the first resource is 0.
limit
This parameter sets the number of resources that the response returns.
  • If no limit is defined, the response contains the entire list of resources.
  • If a limit is less than the total resources, the list is limited by the limit value; otherwise, all resources are listed.
The returned list of resources is sorted by name. When used, the response is limited by the value of limit.
Querying for all volumes of a specified pool
/v1/pools/P0/volumes
Querying for the first 400 volumes of all systems
/v1/pools/P0/volumes?limit=400
Querying for 40 volumes, starting with the 11th volume
/v1/pools/P0/volumes?offset=10&limit=40
Querying for all volumes, starting with the 102nd volume
/v1/pools/P0/volumes?offset=101