Pagination
Function
Neutron APIs v2.0 provides the pagination function. You can set parameters limit and marker in the URL to enable the desired number of items to be returned. All returned items are displayed in the ascending order of ID.
- To access the next page of the request, perform the following configurations:
- Replace the value of marker in the original access request URL. Replace the value of marker to the value of marker in the value of herf if the value of rel in the response is next.
- Set the value of page_reverse to False.
- To access the previous page of the request, perform the following configurations:
- Replace the value of marker in the original access request URL. Replace the value of marker to the value of marker in the value of herf if the value of rel in the response is previous.
- Set the value of page_reverse to True.
Request Message
Request parameter
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
limit |
Integer |
No |
Specifies the number of items displayed per page. |
marker |
String |
No |
Specifies the ID of the last item in the previous list. If the marker value is invalid, error code 400 will be returned. |
page_reverse |
Boolean |
No |
Specifies the page direction. The value can be True or False. |
Example request 1
GET https://{Endpoint}/v2.0/networks?limit=2&marker=3d42a0d4-a980-4613-ae76-a2cddecff054&page_reverse=False
Example request 2
GET https://{Endpoint}/v2.0/vpc/peerings?limit=2&marker=e5a0c88e-228e-4e62-a8b0-90825b1b7958&page_reverse=True
Response Message
Response parameter
None
Example response 1
{ "networks": [ { "status": "ACTIVE", "subnets": [], "name": "liudongtest ", "admin_state_up": false, "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "id": "60c809cb-6731-45d0-ace8-3bf5626421a9" }, { "status": "ACTIVE", "subnets": [ "132dc12d-c02a-4c90-9cd5-c31669aace04" ], "name": "publicnet", "admin_state_up": true, "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "id": "9daeac7c-a98f-430f-8e38-67f9c044e299" } ], "networks_links": [ { "href": "http://192.168.82.231:9696/v2.0/networks?limit=2&marker=9daeac7c-a98f-430f-8e38-67f9c044e299", "rel": "next" }, { "href": "http://192.168.82.231:9696/v2.0/networks?limit=2&marker=60c809cb-6731-45d0-ace8-3bf5626421a9&page_reverse=True", "rel": "previous" } ] }
Example response 2
{ "peerings_links": [ { "marker": "dd442819-5638-401c-bd48-a82703cf0464", "rel": "next" }, { "marker": "1e13cbaf-3ce4-413d-941f-66d855dbfa7f", "rel": "previous" } ], "peerings": [ { "status": "ACTIVE", "accept_vpc_info": { "vpc_id": "83a48834-b9bc-4f70-aa46-074568594650", "tenant_id": "e41a43bf06e249678413c6d61536eff9" }, "request_vpc_info": { "vpc_id": "db8e7687-e43b-4fc1-94cf-16f69f484d6d", "tenant_id": "e41a43bf06e249678413c6d61536eff9" }, "name": "peering1", "id": "1e13cbaf-3ce4-413d-941f-66d855dbfa7f" }, { "status": "ACTIVE", "accept_vpc_info": { "vpc_id": "83a48834-b9bc-4f70-aa46-074568594650", "tenant_id": "e41a43bf06e249678413c6d61536eff9" }, "request_vpc_info": { "vpc_id": "bd63cc9e-e7b8-4d4e-a0e9-055031470ffc", "tenant_id": "e41a43bf06e249678413c6d61536eff9" }, "name": "peering2", "id": "dd442819-5638-401c-bd48-a82703cf0464" } ] }
Status Code
See Status Codes.
Error Code
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.