diff options
author | Sean Dague <sean@dague.net> | 2016-04-12 09:03:46 -0400 |
---|---|---|
committer | Sean Dague <sean@dague.net> | 2016-04-13 07:34:45 -0400 |
commit | d4e27714405e064ba8f62070e8c48d7fa71b6996 (patch) | |
tree | bd8b560fdc3864ea1c121b069926cd6b1d569556 /api-ref/source/os-security-group-default-rules.inc | |
parent | f1fa7eb15a8b4a081d8d8afd3e6d80302c20e39e (diff) | |
download | nova-d4e27714405e064ba8f62070e8c48d7fa71b6996.tar.gz |
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
Diffstat (limited to 'api-ref/source/os-security-group-default-rules.inc')
-rw-r--r-- | api-ref/source/os-security-group-default-rules.inc | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/api-ref/source/os-security-group-default-rules.inc b/api-ref/source/os-security-group-default-rules.inc new file mode 100644 index 0000000000..5bf99a8651 --- /dev/null +++ b/api-ref/source/os-security-group-default-rules.inc @@ -0,0 +1,152 @@ +.. -*- rst -*- + +==================================================================== + Rules for default security group (os-security-group-default-rules) +==================================================================== + +Lists, shows information for, and creates default security group rules. + +List Default Security Group Rules +================================= + +.. rest_method:: GET /v2.1/{tenant_id}/os-security-group-default-rules + +Lists default security group rules. + +Normal response codes: 200,,503,400,401,403,405,404 + +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 + + - from_port: from_port + - id: id + - ip_protocol: ip_protocol + - ip_range: ip_range + - cidr: cidr + - to_port: to_port + +**Example List default security group rules: JSON response** + +.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rules-list-resp.json + :language: javascript + +Create Default Security Group Rule +================================== + +.. rest_method:: POST /v2.1/{tenant_id}/os-security-group-default-rules + +Creates a default security group rule. + +If you specify a source port ( ``from_port`` ) or destination port ( ``to_port`` ) value, you must specify an IP protocol ( ``ip_protocol`` ) value. Otherwise, the operation returns the ``Bad Request (400)`` response code. + +Normal response codes: 200,,503,400,401,403,405,404 + +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 + - id: id + - ip_protocol: ip_protocol + - from_port: from_port + - to_port: to_port + - cidr: cidr + +**Example Create default security group rule: JSON request** + +.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rule-create-req.json + :language: javascript + +Response +^^^^^^^^ + +.. rest_parameters:: parameters.yaml + + - from_port: from_port + - id: id + - ip_protocol: ip_protocol + - ip_range: ip_range + - cidr: cidr + - to_port: to_port + +**Example Create default security group rule: JSON response** + +.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rule-create-resp.json + :language: javascript + +Show Default Security Group Rule Details +======================================== + +.. rest_method:: GET /v2.1/{tenant_id}/os-security-group-default-rules/{security_group_default_rule_id} + +Shows details for a security group rule. + +Normal response codes: 200,,503,400,401,403,405,404 + +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_default_rule_id: security_group_default_rule_id + +Response +^^^^^^^^ + +.. rest_parameters:: parameters.yaml + + - from_port: from_port + - id: id + - ip_protocol: ip_protocol + - ip_range: ip_range + - cidr: cidr + - to_port: to_port + +**Example Show default security group rule: JSON response** + +.. literalinclude:: ../../doc/api_samples/os-security-group-default-rules/security-group-default-rule-show-resp.json + :language: javascript + +Delete Default Security Group Rule +================================== + +.. rest_method:: DELETE /v2.1/{tenant_id}/os-security-group-default-rules/{security_group_default_rule_id} + +Deletes a security group rule. + +Normal response codes: 204,,503,400,401,403,405,404 + +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_default_rule_id: security_group_default_rule_id + +Response +^^^^^^^^ + |