6cfa2c03d7
This patch corrects descriptions of request/response parmaters of security-groups api. Partially-Implements: blueprint neutron-in-tree-api-ref Closes-Bug: #1614815 Co-Authored-By: Anindita Das <anindita.das@intel.com> Change-Id: I48df20026118f6f62bbb7da4a216227b89b9bf3d
187 lines
4.5 KiB
ReStructuredText
187 lines
4.5 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
.. _security_group_rules:
|
|
|
|
===========================================
|
|
Security group rules (security-group-rules)
|
|
===========================================
|
|
|
|
Lists, creates, shows information for, and deletes security group
|
|
rules.
|
|
|
|
List security group rules
|
|
=========================
|
|
|
|
.. rest_method:: GET /v2.0/security-group-rules
|
|
|
|
Lists a summary of all OpenStack Networking security group rules that the project can access.
|
|
|
|
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>`__.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 401
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- fields: fields
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- security_group_rules: security_group_rules
|
|
- remote_group_id: remote_group_id
|
|
- direction: direction
|
|
- protocol: protocol
|
|
- ethertype: ethertype
|
|
- port_range_max: port_range_max
|
|
- security_group_id: security_group_rule-security_group_id
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- port_range_min: port_range_min
|
|
- remote_ip_prefix: remote_ip_prefix
|
|
- id: security_group_rule-id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/security-groups/security-group-rules-list-response.json
|
|
:language: javascript
|
|
|
|
Create security group rule
|
|
==========================
|
|
|
|
.. rest_method:: POST /v2.0/security-group-rules
|
|
|
|
Creates an OpenStack Networking security group rule.
|
|
|
|
Normal response codes: 201
|
|
|
|
Error response codes: 400, 401, 404, 409
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- security_group_rule: security_group_rule
|
|
- remote_group_id: remote_group_id
|
|
- direction: direction
|
|
- protocol: protocol
|
|
- ethertype: ethertype
|
|
- port_range_max: port_range_max
|
|
- security_group_id: security_group_rule-security_group_id
|
|
- port_range_min: port_range_min
|
|
- remote_ip_prefix: remote_ip_prefix
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/security-groups/security-group-rule-create-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- security_group_rule: security_group_rule
|
|
- remote_group_id: remote_group_id
|
|
- direction: direction
|
|
- protocol: protocol
|
|
- ethertype: ethertype
|
|
- port_range_max: port_range_max
|
|
- security_group_id: security_group_rule-security_group_id
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- port_range_min: port_range_min
|
|
- remote_ip_prefix: remote_ip_prefix
|
|
- id: security_group_rule-id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/security-groups/security-group-rule-create-response.json
|
|
:language: javascript
|
|
|
|
Show security group rule
|
|
========================
|
|
|
|
.. rest_method:: GET /v2.0/security-group-rules/{security_group_rule_id}
|
|
|
|
Shows detailed information for a security group rule.
|
|
|
|
The response body contains the following information about the
|
|
security group rule:
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 401, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- security_group_rule_id: security_group_rule-id-path
|
|
- verbose: verbose
|
|
- fields: fields
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- security_group_rule: security_group_rule
|
|
- remote_group_id: remote_group_id
|
|
- direction: direction
|
|
- protocol: protocol
|
|
- ethertype: ethertype
|
|
- port_range_max: port_range_max
|
|
- security_group_id: security_group_rule-security_group_id
|
|
- tenant_id: project_id
|
|
- project_id: project_id
|
|
- port_range_min: port_range_min
|
|
- remote_ip_prefix: remote_ip_prefix
|
|
- id: security_group_rule-id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/security-groups/security-group-rule-show-response.json
|
|
:language: javascript
|
|
|
|
Delete security group rule
|
|
==========================
|
|
|
|
.. rest_method:: DELETE /v2.0/security-group-rules/{security_group_rule_id}
|
|
|
|
Deletes a rule from an OpenStack Networking security group.
|
|
|
|
Normal response codes: 204
|
|
|
|
Error response codes: 401, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- security_group_rule_id: security_group_rule-id-path
|
|
|
|
Response
|
|
--------
|
|
|
|
There is no body content is returned on a successful DELETE request.
|