openstack/nova
Code Issues Proposed changes
ccee8b3c13
nova/api-ref/source/os-security-groups.inc
Sean Dague d4e2771440 Import RST files for documentation 
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.

Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-13 07:34:45 -04:00

230 lines
5.0 KiB
ReStructuredText
Raw Blame History

.. -*- rst -*-
======================================
Security groups (os-security-groups)
======================================
Lists, shows information for, creates, and deletes security groups.
List Security Groups
====================
.. rest_method:: GET /v2.1/{tenant_id}/os-security-groups
Lists security groups.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response
^^^^^^^^
.. rest_parameters:: parameters.yaml
- security_groups: security_groups
- description: description
- id: id
- name: name
- rules: rules
- tenant_id: tenant_id
**Example List security groups: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-groups-list-resp.json
:language: javascript
Create Security Group
=====================
.. rest_method:: POST /v2.1/{tenant_id}/os-security-groups
Creates a security group.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- security_group: security_group
- name: name
- description: description
**Example Create security group: JSON request**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-create-req.json
:language: javascript
Response
^^^^^^^^
.. rest_parameters:: parameters.yaml
- security_group: security_group
- description: description
- id: id
- name: name
- rules: rules
- tenant_id: tenant_id
**Example Create security group: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-create-resp.json
:language: javascript
Show Security Group Details
===========================
.. rest_method:: GET /v2.1/{tenant_id}/os-security-groups/{security_group_id}
Shows details for a security group.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- security_group_id: security_group_id
Response
^^^^^^^^
.. rest_parameters:: parameters.yaml
- security_group: security_group
- description: description
- id: id
- name: name
- rules: rules
- tenant_id: tenant_id
**Example Show security group: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-show-resp.json
:language: javascript
Update Security Group
=====================
.. rest_method:: PUT /v2.1/{tenant_id}/os-security-groups/{security_group_id}
Updates a security group.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- security_group_id: security_group_id
- name: name
- description: description
**Example Update security group: JSON request**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-update-req.json
:language: javascript
Response
^^^^^^^^
.. rest_parameters:: parameters.yaml
- security_group: security_group
- description: description
- id: id
- name: name
- rules: rules
- tenant_id: tenant_id
**Example Update security group: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-group-update-resp.json
:language: javascript
Delete Security Group
=====================
.. rest_method:: DELETE /v2.1/{tenant_id}/os-security-groups/{security_group_id}
Deletes a security group.
Normal response codes: 202
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- security_group_id: security_group_id
Response
^^^^^^^^
List Security Groups By Server
==============================
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-security-groups
Lists security groups for a server.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id
Response
^^^^^^^^
.. rest_parameters:: parameters.yaml
- security_groups: security_groups
- description: description
- id: id
- name: name
- rules: rules
- tenant_id: tenant_id
**Example List security groups by server: JSON response**
.. literalinclude:: ../../doc/api_samples/os-security-groups/security-groups-list-resp.json
:language: javascript
View Git Blame Copy Permalink