f4b9c1201e
Adds/corrects the description request/response parameter as applicable to core resources (see defect). Change-Id: I397a05f17527fde31f657e381775a0bf998455a8 Closes-Bug: #1553653
270 lines
6.3 KiB
ReStructuredText
270 lines
6.3 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
====================================
|
|
Subnet pools extension (subnetpools)
|
|
====================================
|
|
|
|
Lists, creates, shows details for, updates, and deletes subnet
|
|
pools.
|
|
|
|
Show subnet pool
|
|
================
|
|
|
|
.. rest_method:: GET /v2.0/subnetpools/{subnetpool_id}
|
|
|
|
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>`__.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 404, 401
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- subnetpool_id: subnetpool_id
|
|
- fields: fields
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- subnetpool: subnetpool
|
|
- id: subnetpool_id_body
|
|
- name: name
|
|
- default_quota: default_quota
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- created_at: created_at
|
|
- updated_at: updated_at
|
|
- prefixes: prefixes
|
|
- min_prefixlen: min_prefixlen
|
|
- address_scope_id: address_scope_id
|
|
- ip_version: ip_version
|
|
- shared: shared
|
|
- default_prefixlen: default_prefixlen
|
|
- max_prefixlen: max_prefixlen
|
|
- description: description
|
|
- is_default: subnetpool_is_default
|
|
- revision_number: subnetpool_revision_number
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/subnets/subnetpool-show-response.json
|
|
:language: javascript
|
|
|
|
Update subnet pool
|
|
==================
|
|
|
|
.. rest_method:: PUT /v2.0/subnetpools/{subnetpool_id}
|
|
|
|
Updates a subnet pool.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 404, 403, 401, 400
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- subnetpool_id: subnetpool_id
|
|
- subnetpool: subnetpool
|
|
- name: name
|
|
- default_quota: default_quota
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- prefixes: prefixes
|
|
- min_prefixlen: min_prefixlen
|
|
- address_scope_id: address_scope_id
|
|
- default_prefixlen: default_prefixlen
|
|
- max_prefixlen: max_prefixlen
|
|
- description: description-request
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/subnets/subnetpool-update-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- subnetpool: subnetpool
|
|
- id: subnetpool_id_body
|
|
- name: name
|
|
- default_quota: default_quota
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- created_at: created_at
|
|
- updated_at: updated_at
|
|
- prefixes: prefixes
|
|
- min_prefixlen: min_prefixlen
|
|
- address_scope_id: address_scope_id
|
|
- ip_version: ip_version
|
|
- shared: shared
|
|
- default_prefixlen: default_prefixlen
|
|
- max_prefixlen: max_prefixlen
|
|
- description: description
|
|
- is_default: subnetpool_is_default
|
|
- revision_number: subnetpool_revision_number
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/subnets/subnetpool-update-response.json
|
|
:language: javascript
|
|
|
|
Delete subnet pool
|
|
==================
|
|
|
|
.. rest_method:: DELETE /v2.0/subnetpools/{subnetpool_id}
|
|
|
|
Deletes a subnet pool.
|
|
|
|
The operation fails if any subnets allocated from the subnet pool
|
|
are still in use.
|
|
|
|
Normal response codes: 204
|
|
|
|
Error response codes: 404, 401
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- subnetpool_id: subnetpool_id
|
|
|
|
Response
|
|
--------
|
|
|
|
There is no body content for the response of a successful DELETE request.
|
|
|
|
List subnet pools
|
|
=================
|
|
|
|
.. rest_method:: GET /v2.0/subnetpools
|
|
|
|
Lists subnet pools that the project has access to.
|
|
|
|
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>`__.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 401
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- fields: fields
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- subnetpools: subnetpools
|
|
- id: subnetpool_id_body
|
|
- name: name
|
|
- default_quota: default_quota
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- created_at: created_at
|
|
- updated_at: updated_at
|
|
- prefixes: prefixes
|
|
- min_prefixlen: min_prefixlen
|
|
- address_scope_id: address_scope_id
|
|
- ip_version: ip_version
|
|
- shared: shared
|
|
- default_prefixlen: default_prefixlen
|
|
- max_prefixlen: max_prefixlen
|
|
- description: description
|
|
- is_default: subnetpool_is_default
|
|
- revision_number: subnetpool_revision_number
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/subnets/subnetpools-list-response.json
|
|
:language: javascript
|
|
|
|
Create subnet pool
|
|
==================
|
|
|
|
.. rest_method:: POST /v2.0/subnetpools
|
|
|
|
Creates a subnet pool.
|
|
|
|
Normal response codes: 201
|
|
|
|
Error response codes: 404, 403, 401, 400
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- subnetpool: subnetpool
|
|
- name: name
|
|
- default_quota: default_quota
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- prefixes: prefixes
|
|
- min_prefixlen: min_prefixlen
|
|
- address_scope_id: address_scope_id
|
|
- shared: shared
|
|
- default_prefixlen: default_prefixlen
|
|
- max_prefixlen: max_prefixlen
|
|
- description: description-request
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/subnets/subnetpool-create-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- subnetpool: subnetpool
|
|
- id: subnetpool_id_body
|
|
- name: name
|
|
- default_quota: default_quota
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- created_at: created_at
|
|
- updated_at: updated_at
|
|
- prefixes: prefixes
|
|
- min_prefixlen: min_prefixlen
|
|
- address_scope_id: address_scope_id
|
|
- ip_version: ip_version
|
|
- shared: shared
|
|
- default_prefixlen: default_prefixlen
|
|
- max_prefixlen: max_prefixlen
|
|
- description: description
|
|
- is_default: subnetpool_is_default
|
|
- revision_number: subnetpool_revision_number
|