c28b3ab8fe
The spec networking_general_api_information.html was moved to api-ref in [0] but some of the links pointing to it were not updated. This change makes all the refs consistent and adds links where missing. Also moved sync/async and bulk create sections lower to group all the filtering, pagination and sorting sections together since they are inter-related. [0] https://review.opendev.org/c/openstack/neutron-lib/+/362877 Change-Id: I895cc9aaee2546b95e93150c134f350a50346447
211 lines
4.3 KiB
ReStructuredText
211 lines
4.3 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
===================
|
|
Logging Resources
|
|
===================
|
|
|
|
.. note:: Currently this extension ``logging-resource`` is only available for networking-midonet.
|
|
|
|
Lists, shows information for, creates, updates and deletes logging resources.
|
|
|
|
List Logging Resources
|
|
======================
|
|
|
|
.. rest_method:: GET /v2.0/logging/logging_resources
|
|
|
|
Lists logging resources.
|
|
|
|
.. include:: filtering-list.inc
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 401, 403
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- fields: fields
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resources: logging_resources
|
|
- id: logging_resource_id-body
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- firewall_logs: firewall_logs
|
|
- name: name
|
|
- description: description
|
|
- enabled: logging_resource_enabled
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/logging_resource/logging_resources-list-response.json
|
|
:language: javascript
|
|
|
|
Create Logging Resource
|
|
=======================
|
|
|
|
.. rest_method:: POST /v2.0/logging/logging_resources
|
|
|
|
Creates a logging resource.
|
|
|
|
Normal response codes: 201
|
|
|
|
Error response codes: 400, 401, 403
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource: logging_resource
|
|
- tenant_id: project_id-request
|
|
- project_id: project_id-request
|
|
- name: name-request
|
|
- description: description-request
|
|
- enabled: logging_resource_enabled-request
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/logging_resource/logging_resource-create-request.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource: logging_resource
|
|
- id: logging_resource_id-body
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- firewall_logs: firewall_logs
|
|
- name: name
|
|
- description: description
|
|
- enabled: logging_resource_enabled
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/logging_resource/logging_resource-create-response.json
|
|
:language: javascript
|
|
|
|
Show Logging Resource Details
|
|
=============================
|
|
|
|
.. rest_method:: GET /v2.0/logging/logging_resources/{logging_resource_id}
|
|
|
|
Shows details for a logging resource.
|
|
|
|
.. include:: filtering-show.inc
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 400, 401, 403, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource_id: logging_resource_id
|
|
- fields: fields
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource: logging_resource
|
|
- id: logging_resource_id-body
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- firewall_logs: firewall_logs
|
|
- name: name
|
|
- description: description
|
|
- enabled: logging_resource_enabled
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/logging_resource/logging_resource-show-response.json
|
|
:language: javascript
|
|
|
|
Update Logging Resource
|
|
=======================
|
|
|
|
.. rest_method:: PUT /v2.0/logging/logging_resources/{logging_resource_id}
|
|
|
|
Updates a logging resource.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 400, 401, 403, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource_id: logging_resource_id
|
|
- logging_resource: logging_resource
|
|
- name: name-request-put
|
|
- description: description-request-put
|
|
- enabled: logging_resource_enabled-request-put
|
|
|
|
Request Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/logging_resource/logging_resource-update-request.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource: logging_resource
|
|
- id: logging_resource_id-body
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- firewall_logs: firewall_logs
|
|
- name: name
|
|
- description: description
|
|
- enabled: logging_resource_enabled
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/logging_resource/logging_resource-update-response.json
|
|
:language: javascript
|
|
|
|
Delete Logging Resource
|
|
=======================
|
|
|
|
.. rest_method:: DELETE /v2.0/logging/logging_resources/{logging_resource_id}
|
|
|
|
Deletes a logging resource.
|
|
|
|
Normal response codes: 204
|
|
|
|
Error response codes: 400, 401, 403, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource_id: logging_resource_id
|
|
|
|
Response
|
|
--------
|
|
|
|
There is no body content for the response of a successful DELETE request.
|