fa7ab5bfc1
It seems that I forgot to add this to the firewall log api-ref change. [1] [1] I264b3855890d1e2dbfa68c540ae3f0e9416c2a48 Partial-Bug: #1614349 Change-Id: I4dd63d951c42d14d66c8a93a67a75305697fe5ff
205 lines
4.4 KiB
ReStructuredText
205 lines
4.4 KiB
ReStructuredText
.. -*- rst -*-
|
|
.. needs:method_verification
|
|
.. needs:parameter_verification
|
|
.. needs:example_verification
|
|
.. needs:body_verification
|
|
|
|
===============
|
|
Firewall Logs
|
|
===============
|
|
|
|
Lists, shows information for, creates, updates and deletes firewall logs.
|
|
|
|
List Firewall Logs
|
|
==================
|
|
|
|
.. rest_method:: GET /v2.0/logging/logging_resources/{logging_resource_id}/firewall_logs.json
|
|
|
|
Lists firewall logs.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource_id: logging_resource_id
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource_id: logging_resource_id-body
|
|
- id: firewall_log_id-body
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- description: description
|
|
- fw_event: fw_event
|
|
- firewall_id: firewall_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/firewall_log/firewall_logs-list-response.json
|
|
:language: javascript
|
|
|
|
Create Firewall Log
|
|
===================
|
|
|
|
.. rest_method:: POST /v2.0/logging/logging_resources/{logging_resource_id}/firewall_logs.json
|
|
|
|
Creates a firewall log.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource_id: logging_resource_id
|
|
- tenant_id: project_id-request
|
|
- project_id: project_id-request
|
|
- description: description-request
|
|
- fw_event: fw_event-request
|
|
- firewall_id: firewall_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/firewall_log/firewall_log-create-request.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource_id: logging_resource_id-body
|
|
- id: firewall_log_id-body
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- description: description
|
|
- fw_event: fw_event
|
|
- firewall_id: firewall_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/firewall_log/firewall_log-create-response.json
|
|
:language: javascript
|
|
|
|
Show Firewall Log Details
|
|
=========================
|
|
|
|
.. rest_method:: GET /v2.0/logging/logging_resources/{logging_resource_id}/firewall_logs/{firewall_log_id}.json
|
|
|
|
Shows details for a firewall log.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource_id: logging_resource_id
|
|
- firewall_log_id: firewall_log_id
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource_id: logging_resource_id-body
|
|
- id: firewall_log_id-body
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- description: description
|
|
- fw_event: fw_event
|
|
- firewall_id: firewall_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/firewall_log/firewall_log-show-response.json
|
|
:language: javascript
|
|
|
|
Update Firewall Log
|
|
===================
|
|
|
|
.. rest_method:: PUT /v2.0/logging/logging_resources/{logging_resource_id}/firewall_logs/{firewall_log_id}.json
|
|
|
|
Updates a firewall log.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource_id: logging_resource_id
|
|
- firewall_log_id: firewall_log_id
|
|
- description: description-request-put
|
|
- fw_event: fw_event-request-put
|
|
|
|
Request Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/firewall_log/firewall_log-update-request.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource_id: logging_resource_id-body
|
|
- id: firewall_log_id-body
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- description: description
|
|
- fw_event: fw_event
|
|
- firewall_id: firewall_id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/firewall_log/firewall_log-update-response.json
|
|
:language: javascript
|
|
|
|
Delete Firewall Log
|
|
===================
|
|
|
|
.. rest_method:: DELETE /v2.0/logging/logging_resources/{logging_resource_id}/firewall_logs/{firewall_log_id}.json
|
|
|
|
Deletes a firewall log.
|
|
|
|
Normal response codes: 202
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- logging_resource_id: logging_resource_id
|
|
- firewall_log_id: firewall_log_id
|
|
|
|
Response
|
|
--------
|
|
|
|
There is no body content for the response of a successful Delete request.
|