openstack
/
neutron-lib
Code Issues Proposed changes

Merge "Fix incorrect links for the filtering spec"

This commit is contained in:
Zuul 2024-04-15 09:16:06 +00:00 committed by Gerrit Code Review
parent f6852071ef c28b3ab8fe
commit 688b135d86
57 changed files with 262 additions and 376 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api-ref/source/v2/address-groups.inc
View File

@ -13,9 +13,7 @@ Show address group
Shows information for an address group.
Use the ``fields`` query parameter to control which fields are returned in the response body.
For information, see `Filtering and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200
@ -128,10 +126,7 @@ Default policy settings return only the address groups owned by
the project of the user submitting the request, unless the
user has administrative role.
Use the ``fields`` query parameter to control which fields are returned in the response body.
Additionally, you can filter results by using query string parameters.
For information, see `Filtering and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200

9
api-ref/source/v2/address-scopes.inc
View File

@ -13,9 +13,7 @@ Show address scope
Shows information for an address scope.
Use the ``fields`` query parameter to control which fields are returned in the response body.
For information, see `Filtering and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200
@ -128,10 +126,7 @@ Default policy settings return only the address scopes owned by
the project of the user submitting the request, unless the
user has administrative role.
Use the ``fields`` query parameter to control which fields are returned in the response body.
Additionally, you can filter results by using query string parameters.
For information, see `Filtering and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200

10
api-ref/source/v2/agents.inc
View File

@ -24,13 +24,9 @@ List all agents
.. rest_method:: GET /v2.0/agents
Shows details for an agent.
Lists all agents.
Use the ``fields`` query parameter to control which fields are
returned in the response body. For information, see `Filtering and
Column Selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -89,6 +85,8 @@ Show agent details
Shows details for an agent.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404

6
api-ref/source/v2/auto-topology.inc
View File

@ -16,11 +16,7 @@ Show auto allocated topology details
Shows details for an auto allocated topology.
Use the ``fields`` query parameter to control which fields are
returned in the response body. For information, see `Filtering and
Column Selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200

2
api-ref/source/v2/availability_zones.inc
View File

@ -13,6 +13,8 @@ List all availability zones
Lists all availability zones.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401

2
api-ref/source/v2/bgp_dragent_scheduler.inc
View File

@ -41,6 +41,8 @@ List BGP speakers hosted by a Dynamic Routing Agent
Issue a ``GET`` request to ``/v2.0/agents/{bgp-dragent-id}/bgp-drinstances`` to
list all BGP Seakers hosted on the specified dynamic routing agent.
.. include:: filtering-list.inc
Normal response codes: 200
Request

8
api-ref/source/v2/bgp_peer.inc
View File

@ -19,11 +19,7 @@ List BGP Peers
Issue a ``GET`` request to ``/v2.0/bgp-peers`` to retrieve the list of available
BGP peers.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -60,6 +56,8 @@ Show BGP Peer details
.. rest_method:: GET /v2.0/bgp-peers/{bgp-peer-id}
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404

12
api-ref/source/v2/bgp_speaker.inc
View File

@ -23,11 +23,7 @@ List BGP Speakers
Issue a ``GET`` request to ``/v2.0/bgp-speakers`` to retrieve this list of available
BGP Speakers.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -70,6 +66,8 @@ Show BGP Speaker details
Issue a ``GET`` request to ``/v2.0/bgp-speakers/<bgp-speaker-id>`` to retrieve the
detail about a specific BGP Speaker.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
@ -340,6 +338,8 @@ List routes advertised by a BGP Speaker
List all routes advertised by the specified BGP Speaker.
.. include:: filtering-list.inc
Normal response codes: 200
Response Parameters
@ -364,6 +364,8 @@ List Dynamic Routing Agents hosting a specific BGP Speaker
List all BGP dynamic agents which are hosting the specified BGP Speaker.
.. include:: filtering-list.inc
Normal response codes: 200
Response Parameters

8
api-ref/source/v2/bgpvpn-bgpvpns.inc
View File

@ -21,11 +21,7 @@ List BGP VPNs
Lists BGP VPNs to which the project has access.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -132,6 +128,8 @@ Show BGP VPN details
Shows details for a BGP VPN.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404

8
api-ref/source/v2/bgpvpn-network_associations.inc
View File

@ -18,11 +18,7 @@ List Network Associations
Lists network associations for a given BGP VPN.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -103,6 +99,8 @@ Show Network Association details
Shows details for a network association.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404

8
api-ref/source/v2/bgpvpn-port_associations.inc
View File

@ -57,11 +57,7 @@ List Port Associations
Lists port associations for a given BGP VPN.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -146,6 +142,8 @@ Show Port Association details
Shows details for a port association.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404

8
api-ref/source/v2/bgpvpn-router_associations.inc
View File

@ -36,11 +36,7 @@ List Router Associations
Lists router associations for a given BGP VPN.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -121,6 +117,8 @@ Show Router Association details
Shows details for a router association.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404

8
api-ref/source/v2/dhcp-agent-scheduler.inc
View File

@ -14,9 +14,10 @@ List networks hosted by a DHCP agent
.. rest_method:: GET /v2.0/agents/{agent_id}/dhcp-networks
Lists networks that a DHCP agent hosts.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401, 403
@ -137,9 +138,10 @@ List DHCP agents hosting a network
.. rest_method:: GET /v2.0/networks/{network_id}/dhcp-agents
Lists DHCP agents hosting a network.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401, 403
@ -174,4 +176,4 @@ Response Example
----------------
.. literalinclude:: samples/agents/network-dhcp-agent-list-response.json
:language: javascript
:language: javascript

7
api-ref/source/v2/extensions.inc
View File

@ -15,8 +15,9 @@ List extensions
Lists available extensions.
Lists available Networking API v2.0 extensions and shows details
for an extension.
Lists available Networking API v2.0 extensions.
.. include:: filtering-list.inc
Normal response codes: 200
@ -52,6 +53,8 @@ Shows details for an extension, by alias.
The response shows the extension name and its alias. To show
details for an extension, you specify the alias.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404

14
api-ref/source/v2/filtering-list.inc Normal file
View File

@ -0,0 +1,14 @@
Standard query parameters are supported on the URI.
For more information, see `Filtering and Column Selection <#filtering>`__.
Use the ``fields`` query parameter to control which fields are returned
in the response body.
For more information, see `Fields <#fields>`__.
Pagination query parameters are supported if Neutron configuration supports
it by overriding ``allow_pagination=false``.
For more information, see `Pagination <#pagination>`__.
Sorting query parameters are supported if Neutron configuration supports
it with ``allow_sorting=true``.
For more information, see `Sorting <#sorting>`__.

3
api-ref/source/v2/filtering-show.inc Normal file
View File

@ -0,0 +1,3 @@
Use the ``fields`` query parameter to control which fields are returned
in the response body.
For more information, see `Fields <#fields>`__.

9
api-ref/source/v2/fip-port-forwarding.inc
View File

@ -33,9 +33,7 @@ Show port forwarding
Shows information for a floating IP port forwarding.
Use the ``fields`` query parameter to control which fields are returned in the response body.
For information, see `Filtering and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200
@ -163,10 +161,7 @@ Default policy settings return only the port forwardings associated to floating
IPs owned by the project of the user submitting the request, unless the
user has administrative role.
Use the ``fields`` query parameter to control which fields are returned in the response body.
Additionally, you can filter results by using query string parameters.
For information, see `Filtering and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200

12
api-ref/source/v2/firewall_log.inc
View File

@ -15,11 +15,7 @@ List Firewall Logs
Lists firewall logs.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -110,11 +106,7 @@ Show Firewall Log Details
Shows details for a firewall log.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200

18
api-ref/source/v2/flavors.inc
View File

@ -21,17 +21,7 @@ Lists all flavors visible to the project.
The list can be empty.
Standard query parameters are supported on the URI. Use the ``fields``
query parameter to control which fields are returned in the response body.
Additionally, you can filter results by using query string parameters.
For information, see `Filtering and Column Selection
<https://wiki.openstack.org/wiki/Neutron/APIv2-specification#
Filtering_and_Column_Selection>`__. If Neutron configuration supports
pagination by overriding allow_pagination = false, the ``marker`` query
parameter can set the last element id the client has seen and ``limit``
set the maximum number of items to return. if Neutron configuration has
allow_sorting = true, ``sort_key`` and ``sort_dir`` pairs can be used
where sort direction is 'asc' or 'desc'.
.. include:: filtering-list.inc
Normal response codes: 200
@ -154,6 +144,8 @@ administrative user and the flavor object is not visible to your
project account, the service returns the HTTP ``Forbidden (403)``
response code.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404
@ -335,7 +327,7 @@ Lists all service profiles visible for the tenant account.
The list can be empty.
Standard query parameters are supported on the URI.
.. include:: filtering-list.inc
Normal response codes: 200
@ -449,6 +441,8 @@ not an administrative user and the object is not visible to your
tenant account, the service returns the HTTP ``Forbidden (403)``
response code.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404

2
api-ref/source/v2/floatingippools.inc
View File

@ -11,6 +11,8 @@ List floating IP Pools
Lists floating IP pools visible to the user.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401

14
api-ref/source/v2/floatingips.inc
View File

@ -75,6 +75,8 @@ Lists floating IPs visible to the user.
Default policy settings return only the floating IPs owned by the user's
project, unless the user has admin role.
.. include:: filtering-list.inc
This example request lists floating IPs in JSON format:
::
@ -82,12 +84,6 @@ This example request lists floating IPs in JSON format:
GET /v2.0/floatingips
Accept: application/json
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
Normal response codes: 200
Error response codes: 401
@ -278,11 +274,7 @@ Show floating IP details
Shows details for a floating IP.
Use the ``fields`` query parameter to control which fields are
returned in the response body. For information, see `Filtering and
Column Selection <http://specs.openstack.org/openstack /neutron-
specs/specs/api/networking_general_api_information.html #filtering-
and-column-selection>`__.
.. include:: filtering-show.inc
This example request shows details for a floating IP in JSON
format. This example also filters the result by the

24
api-ref/source/v2/fwaas-v2.inc
View File

@ -47,11 +47,7 @@ Lists all firewall groups.
The list might be empty.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -99,6 +95,8 @@ If the user is not an administrative user and the firewall group
object does not belong to the project, this call returns the
``FirewallGroupNotFound (404)`` response code.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404
@ -287,11 +285,7 @@ Lists all firewall policies.
The list might be empty.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -332,6 +326,8 @@ Show firewall policy details
Shows details of a firewall policy.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404
@ -500,11 +496,7 @@ Lists all firewall rules.
The list might be empty.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -558,6 +550,8 @@ If the user is not an administrative user and the firewall rule
object does not belong to the project, this call returns the
``Forbidden (403)`` response code.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404

92
api-ref/source/v2/intro.inc
View File

@ -137,7 +137,6 @@ with the different OR criteria. For example, to find all networks named
GET /v2.0/networks?name=foobar&name=bizbaz
ORs and ANDs can be combined. For example, if you want all networks with
admin_state_up=True and shared=True and named ``foobar`` or ``bizbaz``:
@ -171,8 +170,8 @@ available. If an API request contains an unknown or unsupported
parameter, the server will return a ``400`` response instead of silently
ignoring the invalid input.
Note
----
Fields
======
By default, OpenStack Networking returns all attributes for any show or list
call. The Networking API v2.0 has a mechanism to limit the set of attributes
@ -188,49 +187,6 @@ network:
GET /v2.0/networks.json?fields=id&fields=name
Synchronous versus asynchronous plug-in behavior
================================================
The Networking API v2.0 presents a logical model of network connectivity
consisting of networks, ports, and subnets. It is up to the OpenStack
Networking plug-in to communicate with the underlying infrastructure to ensure
packet forwarding is consistent with the logical model. A plug-in might perform
these operations asynchronously.
When an API client modifies the logical model by issuing an HTTP ``POST``,
``PUT``, or ``DELETE`` request, the API call might return before the plug-in
modifies underlying virtual and physical switching devices. However, an API
client is guaranteed that all subsequent API calls properly reflect the changed
logical model.
For example, if a client issues an HTTP ``PUT`` request to set the attachment
for a port, there is no guarantee that packets sent by the interface named in
the attachment are forwarded immediately when the HTTP call returns. However,
it is guaranteed that a subsequent HTTP ``GET`` request to view the attachment
on that port returns the new attachment value.
You can use the ``status`` attribute with the network and port resources to
determine whether the OpenStack Networking plug-in has successfully completed
the configuration of the resource.
Bulk-create
===========
The Networking API v2.0 enables you to create several objects of the same type
in the same API request. Bulk create operations use exactly the same API syntax
as single create operations except that you specify a list of objects rather
than a single object in the request body.
Bulk operations are always performed atomically, meaning that either all or
none of the objects in the request body are created. If a particular plug-in
does not support atomic operations, the Networking API v2.0 emulates the atomic
behavior so that users can expect the same behavior regardless of the
particular plug-in running in the background.
OpenStack Networking might be deployed without support for bulk operations and
when the client attempts a bulk create operation, a ``400`` Bad request error is
returned.
Pagination
==========
@ -371,7 +327,6 @@ The last page won't show the ``next`` links
]
}
Sorting
=======
@ -399,6 +354,49 @@ If an API request contains an unknown or unsupported sort key,
the server will return a ``400`` response instead of silently ignoring
the invalid input.
Synchronous versus asynchronous plug-in behavior
================================================
The Networking API v2.0 presents a logical model of network connectivity
consisting of networks, ports, and subnets. It is up to the OpenStack
Networking plug-in to communicate with the underlying infrastructure to ensure
packet forwarding is consistent with the logical model. A plug-in might perform
these operations asynchronously.
When an API client modifies the logical model by issuing an HTTP ``POST``,
``PUT``, or ``DELETE`` request, the API call might return before the plug-in
modifies underlying virtual and physical switching devices. However, an API
client is guaranteed that all subsequent API calls properly reflect the changed
logical model.
For example, if a client issues an HTTP ``PUT`` request to set the attachment
for a port, there is no guarantee that packets sent by the interface named in
the attachment are forwarded immediately when the HTTP call returns. However,
it is guaranteed that a subsequent HTTP ``GET`` request to view the attachment
on that port returns the new attachment value.
You can use the ``status`` attribute with the network and port resources to
determine whether the OpenStack Networking plug-in has successfully completed
the configuration of the resource.
Bulk-create
===========
The Networking API v2.0 enables you to create several objects of the same type
in the same API request. Bulk create operations use exactly the same API syntax
as single create operations except that you specify a list of objects rather
than a single object in the request body.
Bulk operations are always performed atomically, meaning that either all or
none of the objects in the request body are created. If a particular plug-in
does not support atomic operations, the Networking API v2.0 emulates the atomic
behavior so that users can expect the same behavior regardless of the
particular plug-in running in the background.
OpenStack Networking might be deployed without support for bulk operations and
when the client attempts a bulk create operation, a ``400`` Bad request error is
returned.
.. _Extensions:

8
api-ref/source/v2/l3-agent-scheduler.inc
View File

@ -13,9 +13,10 @@ List routers hosted by an L3 agent
.. rest_method:: GET /v2.0/agents/{agent_id}/l3-routers
Lists routers that an l3 agent hosts.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401, 404
@ -125,9 +126,10 @@ List L3 agents hosting a router
.. rest_method:: GET /v2.0/routers/{router_id}/l3-agents
Lists l3 agents hosting a specific router.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401, 404
@ -162,4 +164,4 @@ Response Example
----------------
.. literalinclude:: ../v2/samples/agents/router-l3-agent-list-response.json
:language: javascript
:language: javascript

9
api-ref/source/v2/l3-conntrack-helper.inc
View File

@ -14,9 +14,7 @@ Show conntrack helper
Shows information for a router conntrack helper.
Use the ``fields`` query parameter to control which fields are returned in the response body.
For information, see `Filtering and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200
@ -125,10 +123,7 @@ List router conntrack helpers
Lists router conntrack helpers associated with a router.
Use the ``fields`` query parameter to control which fields are returned in the response body.
Additionally, you can filter results by using query string parameters.
For information, see `Filtering and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200

18
api-ref/source/v2/local-ips.inc
View File

@ -24,11 +24,7 @@ Lists Local IPs visible to the user.
Default policy settings return only the Local IPs owned by the user's
project, unless the user has admin role.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -168,11 +164,7 @@ Show Local IP details
Shows details for a Local IP.
Use the ``fields`` query parameter to control which fields are
returned in the response body. For information, see `Filtering and
Column Selection <http://specs.openstack.org/openstack /neutron-
specs/specs/api/networking_general_api_information.html #filtering-
and-column-selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200
@ -305,11 +297,7 @@ List Local IP Associations
Lists Associations for the given Local IP.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200

12
api-ref/source/v2/logging.inc
View File

@ -20,11 +20,7 @@ List logs
Lists all log resources associated with your project.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
The list might be empty.
@ -155,6 +151,8 @@ Show log
Shows details log resource.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
@ -280,6 +278,8 @@ List loggable resources
Lists all resource log types are supporting.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
@ -299,4 +299,4 @@ Response Example
----------------
.. literalinclude:: samples/logs/loggable_resources-list-response.json
:language: javascript
:language: javascript

12
api-ref/source/v2/logging_resource.inc
View File

@ -15,11 +15,7 @@ List Logging Resources
Lists logging resources.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -108,11 +104,7 @@ Show Logging Resource Details
Shows details for a logging resource.
Use the ``fields`` query parameter to control which fields are
returned in the response body. For information, see `Filtering and
Column Selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200

16
api-ref/source/v2/metering.inc
View File

@ -16,11 +16,7 @@ Lists all L3 metering labels that belong to the project.
The list shows the ID for each metering label.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -115,6 +111,8 @@ Show metering label details
Shows details for a metering label.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
@ -189,11 +187,7 @@ Lists a summary of all L3 metering label rules that belong to the project.
The list shows the ID for each metering label rule.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -309,6 +303,8 @@ The response body shows this information for each metering label rule:
- The metering label ID for the metering label with which the rule
is associated.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404

4
api-ref/source/v2/network-ip-availability.inc
View File

@ -18,6 +18,8 @@ Shows network IP availability details for a network.
By default policy configuration, only administrative users can retrieve
IP availability. Otherwise, ``Not Found (404)`` will be returned.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
@ -63,6 +65,8 @@ Lists network IP availability of all networks.
By default policy configuration, only administrative users can retrieve
IP availabilities. Otherwise, an empty list will be returned.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401

11
api-ref/source/v2/network_segment_ranges.inc
View File

@ -33,11 +33,7 @@ Show network segment range details
Shows details for a network segment range.
You can control which response parameters are returned by using the
fields query parameter. For information, see `Filtering and column
selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200
@ -170,10 +166,7 @@ List network segment ranges
Lists network segment ranges to which the admin has access.
Use the ``fields`` query parameter to filter the response. For
information, see `Filtering and Column Selection <https://wiki.open
stack.org/wiki/Neutron/APIv2-specification#Filtering_and_Column_Sel
ection>`__.
.. include:: filtering-list.inc
Normal response codes: 200

12
api-ref/source/v2/networks.inc
View File

@ -179,11 +179,7 @@ Show network details
Shows details for a network.
Use the ``fields`` query parameter to control which fields are
returned in the response body. For information, see `Filtering and
Column Selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200
@ -382,11 +378,7 @@ Default policy settings return only networks that the project who submits the
request owns, unless an administrative user submits the request. In addition,
networks shared with the project who submits the request are also returned.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
.. TODO(amotoki): Add description on tag filtering to the general API overview.

2
api-ref/source/v2/port_bindings.inc
View File

@ -18,6 +18,8 @@ Show Port Binding of a Port
.. rest_method:: GET /v2.0/ports/{port_id}/bindings
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404

12
api-ref/source/v2/ports.inc
View File

@ -246,11 +246,7 @@ Show port details
Shows details for a port.
Use the ``fields`` query parameter to control which fields are
returned in the response body. For information, see `Filtering and
Column Selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200
@ -493,11 +489,7 @@ Default policy settings return only those ports that are owned by
the project of the user who submits the request, unless the request is submitted
by a user with administrative rights.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
If the ``ip-substring-filtering`` extension is enabled, the Neutron API
supports IP address substring filtering on the ``fixed_ips`` attribute.

40
api-ref/source/v2/qos.inc
View File

@ -24,11 +24,7 @@ List QoS rule types
Lists available qos rule types.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -63,11 +59,7 @@ Show QoS rule type details
Shows details for an available QoS rule type.
You can control which response parameters are returned by using the
fields query parameter. For information, see `Filtering and column
selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200
@ -136,11 +128,7 @@ more than one rule type.
The list might be empty.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -398,6 +386,8 @@ Lists all bandwidth limit rules for a QoS policy.
The list might be empty.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401, 404
@ -602,6 +592,8 @@ Lists all DSCP marking rules for a QoS policy.
The list may be empty.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401, 404
@ -792,11 +784,7 @@ Lists all minimum bandwidth rules for a QoS policy.
The list might be empty.
You can control which response parameters are returned by using the
fields query parameter. For information, see `Filtering and column
selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -999,11 +987,7 @@ Lists all minimum packet rate rules for a QoS policy.
The list might be empty.
You can control which response parameters are returned by using the
fields query parameter. For information, see `Filtering and column
selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -1205,11 +1189,7 @@ Lists all packet rate limit rules for a QoS policy.
The list might be empty.
You can control which response parameters are returned by using the
fields query parameter. For information, see `Filtering and column
selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200

2
api-ref/source/v2/quota_details.inc
View File

@ -16,6 +16,8 @@ Show quota details for a tenant
Shows quota details for a project.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403

6
api-ref/source/v2/quotas.inc
View File

@ -16,6 +16,8 @@ List quotas for projects with non-default quota values
Lists quotas for projects with non-default quota values.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401, 403
@ -54,6 +56,8 @@ List quotas for a project
Lists quotas for a project.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401, 403
@ -174,6 +178,8 @@ List default quotas for a project
Lists default quotas for a project.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401, 403

11
api-ref/source/v2/rbac-policy.inc
View File

@ -28,11 +28,7 @@ Show RBAC policy details
Show details for a given RBAC policy.
You can control which response parameters are returned by using the
fields query parameter. For information, see `Filtering and column
selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200
@ -138,10 +134,7 @@ List RBAC policies
List RBAC policies that belong to a given tenant.
Use the ``fields`` query parameter to filter the response. For
information, see `Filtering and Column Selection <https://wiki.open
stack.org/wiki/Neutron/APIv2-specification#Filtering_and_Column_Sel
ection>`__.
.. include:: filtering-list.inc
Normal response codes: 200

10
api-ref/source/v2/router-ndp-proxy.inc
View File

@ -20,11 +20,7 @@ Default policy settings return only those ndp_proxies that the project
who submits the request owns, unless an administrative user submits
the request.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -80,9 +76,7 @@ Show ndp proxy details
Shows information for a ndp proxy
Use the ``fields`` query parameter to control which fields are returned in the response body.
For information, see `Filtering and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200

12
api-ref/source/v2/routers.inc
View File

@ -172,11 +172,7 @@ Default policy settings return only those routers that the project
who submits the request owns, unless an administrative user submits
the request.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -335,11 +331,7 @@ Show router details
Shows details for a router.
Use the ``fields`` query parameter to control which fields are
returned in the response body. For information, see `Filtering and
Column Selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200

8
api-ref/source/v2/security-group-rules.inc
View File

@ -36,11 +36,7 @@ Lists a summary of all OpenStack Networking security group rules that the projec
The list provides the ID for each security group rule.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -238,6 +234,8 @@ Shows detailed information for a security group rule.
The response body contains the following information about the
security group rule:
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404

8
api-ref/source/v2/security-groups.inc
View File

@ -64,11 +64,7 @@ Lists OpenStack Networking security groups to which the project has access.
The response is an array of ``security_group`` objects which contains a list of
``security_group_rules`` objects.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -185,6 +181,8 @@ Shows details for a security group.
The associated security group rules are contained in the response.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404

8
api-ref/source/v2/security_groups_default_rules.inc
View File

@ -19,11 +19,7 @@ for every newly created Security Group.
The list provides the ID for each security group default rule.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -153,6 +149,8 @@ Shows detailed information for a security group default rule.
The response body contains the following information about the
security group rule:
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404

11
api-ref/source/v2/segments.inc
View File

@ -20,11 +20,7 @@ Show segment details
Shows details for a segment.
You can control which response parameters are returned by using the
fields query parameter. For information, see `Filtering and column
selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200
@ -137,10 +133,7 @@ List segments
Lists segments to which the project has access.
Use the ``fields`` query parameter to filter the response. For
information, see `Filtering and Column Selection <https://wiki.open
stack.org/wiki/Neutron/APIv2-specification#Filtering_and_Column_Sel
ection>`__.
.. include:: filtering-list.inc
Normal response codes: 200

6
api-ref/source/v2/service-providers.inc
View File

@ -13,11 +13,7 @@ List service providers
Lists service providers and their associated service types.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200

4
api-ref/source/v2/sfc-chains.inc
View File

@ -17,6 +17,8 @@ List Port Chains
Lists port chains.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
@ -98,6 +100,8 @@ Show Port Chain Details
Shows details for a port chain.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

4
api-ref/source/v2/sfc-classifiers.inc
View File

@ -17,6 +17,8 @@ List Flow Classifiers
Lists flow classifiers.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
@ -111,6 +113,8 @@ Show Flow Classifier Details
Shows details for a flow classifier.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

4
api-ref/source/v2/sfc-port-pair-groups.inc
View File

@ -17,6 +17,8 @@ List Port Pair Groups
Lists port pair groups.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
@ -95,6 +97,8 @@ Show Port Pair Group Details
Shows details for a port pair group.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

4
api-ref/source/v2/sfc-port-pairs.inc
View File

@ -17,6 +17,8 @@ List Port Pairs
Lists port pairs.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
@ -97,6 +99,8 @@ Show Port Pair Details
Shows details for a port pair.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

4
api-ref/source/v2/sfc-servicegraph.inc
View File

@ -17,6 +17,8 @@ List Service Graphs
Lists service graphs.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
@ -89,6 +91,8 @@ Show Service Graph Details
Shows details for a service graph.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

10
api-ref/source/v2/subnetpools.inc
View File

@ -34,10 +34,7 @@ Show subnet pool
Shows information for a subnet pool.
Use the ``fields`` query parameter to control which fields are returned in the response body.
Additionally, you can filter results by using query string parameters.
For information, see `Filtering and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200
@ -186,10 +183,7 @@ Default policy settings return only the subnet pools owned by
the project of the user submitting the request, unless the
user has administrative role.
Use the ``fields`` query parameter to control which fields are returned in the response body.
Additionally, you can filter results by using query string parameters.
For information, see `Filtering and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200

8
api-ref/source/v2/subnets.inc
View File

@ -96,11 +96,7 @@ user has administrative role. You can control which attributes
are returned by using the fields query parameter. You can filter
results by using query string parameters.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -391,6 +387,8 @@ Shows details for a subnet.
Use the fields query parameter to filter the results.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404

10
api-ref/source/v2/taas.inc
View File

@ -33,6 +33,8 @@ List tap services that belong to a given project.
The list might be empty.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
@ -186,6 +188,8 @@ Show Tap Service
Show details for a tap service by passing tap service ``name`` or ``id`` as JSON-encoded data.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
@ -234,6 +238,8 @@ List tap flow that belong to a given tenant.
The list might be empty.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
@ -394,6 +400,8 @@ Show Tap Flow
Show details for a tap flow by passing tap flow ``name`` or ``id`` as JSON-encoded data.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
@ -427,4 +435,4 @@ Response Example
----------------
.. literalinclude:: samples/taas/taf-show-response.json
:language: javascript
:language: javascript

4
api-ref/source/v2/tap_mirrors.inc
View File

@ -16,6 +16,8 @@ List tap mirrors that belong to a given project.
The list might be empty.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
@ -174,6 +176,8 @@ Show Tap Mirror
Shows details for a tap mirror.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404

2
api-ref/source/v2/trunk-details.inc
View File

@ -20,6 +20,8 @@ attribute contain the trunk ID and the array showing information
about the subports that belong to the trunk: the port UUID, the
segmentation type, the segmentation ID, and the MAC address.
.. include:: filtering-show.inc
Normal response codes: 200
Request

13
api-ref/source/v2/trunk.inc
View File

@ -47,10 +47,7 @@ Default policy settings return only those trunks that are
owned by the user who submits the request, unless an admin user
submits the request.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see the Filtering_
section for more details.
.. include:: filtering-list.inc
Normal response codes: 200
@ -285,6 +282,8 @@ List subports for trunk
Normal response codes: 200
.. include:: filtering-list.inc
Error response codes: 401, 404
Request
@ -374,11 +373,7 @@ Show trunk
Shows details for a trunk.
Use the ``fields`` query parameter to control which fields are
returned in the response body. For information, see `Filtering and
Column Selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-show.inc
Normal response codes: 200

40
api-ref/source/v2/vpnaas.inc
View File

@ -63,11 +63,7 @@ List IKE policies
Lists IKE policies.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -180,6 +176,8 @@ Show IKE policy details
Shows details for an IKE policy.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404
@ -310,11 +308,7 @@ List IPsec policies
Lists all IPsec policies.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -427,6 +421,8 @@ Show IPsec policy
Shows details for an IPsec policy.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404
@ -557,11 +553,7 @@ List IPsec connections
Lists all IPsec connections.
Use the ``fields`` query parameter to control which fields are
returned in the response body. For information, see `Filtering and
Column Selection <http://specs.openstack.org/openstack/neutron-
specs/specs/api/networking_general_api_information.html#filtering-
and-column-selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -703,6 +695,8 @@ Show IPsec connection
Shows details for an IPsec connection.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404
@ -861,11 +855,7 @@ List VPN endpoint groups
Lists VPN endpoint groups.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -955,6 +945,8 @@ Show VPN endpoint group
Shows details for a VPN endpoint group.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404
@ -1062,11 +1054,7 @@ Lists all VPN services.
The list might be empty.
Use the ``fields`` query parameter to control which fields are
returned in the response body. Additionally, you can filter results
by using query string parameters. For information, see `Filtering
and Column Selection <https://wiki.openstack.org/wiki/Neutron/APIv2
-specification#Filtering_and_Column_Selection>`__.
.. include:: filtering-list.inc
Normal response codes: 200
@ -1182,6 +1170,8 @@ If the user is not an administrative user and the VPN service
object does not belong to the tenant account for the user, the
operation returns the ``Forbidden (403)`` response code.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 403, 404