View Firewall Group Details

(Difference between revisions)
Jump to: navigation, search
m (1 revision)
Line 1: Line 1:
 
This operation will list the details for the specified firewall group.  
 
This operation will list the details for the specified firewall group.  
  
='''GET''' /os-security-groups/'''name'''=
+
='''GET''' /accounts/''{accountId}''/flexcloud/os-security-groups/''{id}''=
 
This operation will list the details for the specified firewall group.
 
This operation will list the details for the specified firewall group.
  
 
== Parameters ==
 
== Parameters ==
; name
+
; accountId - ''string''
 +
: The selected account Id.
 +
 
 +
; id
 
: The unique identifier of the firewall group.
 
: The unique identifier of the firewall group.
  
Line 12: Line 15:
 
  <nowiki>
 
  <nowiki>
 
  {
 
  {
     "security_group" : {
+
     "securityGroup" : {
       "display_name" : "{firewall_group_display_name}",
+
       "displayName" : "{firewall_group_display_name}",
 
       "description" : "{firewall_group_description}",
 
       "description" : "{firewall_group_description}",
 
       "links" : [
 
       "links" : [
 
           {
 
           {
             "href" : "http://{api-server}/os-security-groups/{firewall_group_name}/",
+
             "href" : "http://{api-server}/accounts/{accountId}/flexcloud/os-security-groups/{firewall_group_name}/",
 
    "rel" : "self"
 
    "rel" : "self"
 
           }
 
           }
Line 23: Line 26:
 
       "rules" : [
 
       "rules" : [
 
           {
 
           {
             "fromport" : "{start_port}",
+
             "fromPort" : "{start_port}",
    "toport" : "{end_port}",
+
    "toPort" : "{end_port}",
 
             "protocol" : "{ip_protocol}",
 
             "protocol" : "{ip_protocol}",
             "cidrIp": "0.0.0.0/0",
+
             "cidr": "0.0.0.0/0",
 
    "id" : "145"
 
    "id" : "145"
 
  },
 
  },
 
           {
 
           {
             "fromport" : "{start_port}",
+
             "fromPort" : "{start_port}",
    "toport" : "{end_port}",
+
    "toPort" : "{end_port}",
 
             "protocol" : "{ip_protocol}",
 
             "protocol" : "{ip_protocol}",
             "cidrIp": "127.0.0.1/0",
+
             "cidr": "127.0.0.1/0",
 
    "id" : "169"
 
    "id" : "169"
 
  }
 
  }
 
       ],
 
       ],
 
       "servers" : ["{server_id}"],
 
       "servers" : ["{server_id}"],
       "account_number" : "{user_account_number}",
+
       "accountNumber" : "{user_account_number}",
       "name" : "{firewall_group_name}"
+
       "id" : "{firewall_group_id}"
 
     }
 
     }
  }
+
  }</nowiki>
</nowiki>
+
  
====security_group====
+
====securityGroup====
; display name - ''string''
+
; displayName - ''string''
 
: The display name of the firewall group.
 
: The display name of the firewall group.
  
Line 60: Line 62:
 
: List of server ids this firewall group is assigned to.
 
: List of server ids this firewall group is assigned to.
  
; account_number - ''string''
+
; accountNumber - ''string''
 
: Identifies an account that owns the firewall group.
 
: Identifies an account that owns the firewall group.
  
; name - ''string''
+
; id - ''string''
: The name of this firewall group.*(Unique identifier for this firewall group.)
+
: The id of this firewall group.*(Unique identifier for this firewall group.)
  
 
== Response Codes ==
 
== Response Codes ==
Line 76: Line 78:
 
== Examples ==
 
== Examples ==
 
'''Successfully list details for specified firewall group'''
 
'''Successfully list details for specified firewall group'''
:'''GET''' http(s)://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju
+
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju
  
 
''Request Headers:''
 
''Request Headers:''
Line 89: Line 91:
 
  <nowiki>
 
  <nowiki>
 
  {
 
  {
     "security_group" : {
+
     "securityGroup" : {
       "display_name": "Test Firewall Group 1",  
+
       "displayName": "Test Firewall Group 1",  
 
       "description": "Test firewall group 1 description.",  
 
       "description": "Test firewall group 1 description.",  
 
       "links": [
 
       "links": [
 
           {
 
           {
             "href": "http://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju/",  
+
             "href": "http://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju/",  
 
             "rel": "self"
 
             "rel": "self"
 
           }
 
           }
Line 100: Line 102:
 
       "rules": [  
 
       "rules": [  
 
           {
 
           {
             'toport': 1111,  
+
             'toPort': 1111,  
             'fromport': 1111,  
+
             'fromPort': 1111,  
 
             'protocol': 'TCP',  
 
             'protocol': 'TCP',  
 
             'id': 145,  
 
             'id': 145,  
             'cidrIp': '0.0.0.0/0'
+
             'cidr': '0.0.0.0/0'
 
           },
 
           },
 
           {
 
           {
             'toport': 80,  
+
             'toPort': 80,  
             'fromport': 80,  
+
             'fromPort': 80,  
             'protocol': 'tcp',  
+
             'protocol': 'TCP',  
 
             'id': 196,  
 
             'id': 196,  
             'cidrIp': '127.0.0.1/24'
+
             'cidr': '127.0.0.1/24'
 
           }
 
           }
 
       ],  
 
       ],  
       "name": "group2012May11_OK30Zs7Ju",  
+
       "id": "group2012May11_OK30Zs7Ju",  
       "account_number": "test_account_120761",
+
       "accountNumber": "test_account_120761",
 
       "servers": ["test-server-0003"]
 
       "servers": ["test-server-0003"]
 
     }
 
     }
Line 121: Line 123:
  
 
'''Failure while trying to request details for a firewall group that does not exist'''
 
'''Failure while trying to request details for a firewall group that does not exist'''
:'''GET''' http(s)://{api_server}/os-security-groups/{<span style="color:red">fake_firewall_group_name</span>}
+
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/{<span style="color:red">fake_firewall_group_name</span>}
  
 
''Request Headers:''
 
''Request Headers:''
Line 143: Line 145:
  
 
'''Failure while trying to make unauthorized access'''
 
'''Failure while trying to make unauthorized access'''
:'''GET''' http(s)://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju
+
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju
  
 
''Request Headers:''
 
''Request Headers:''
Line 159: Line 161:
 
     wrong credentials (e.g., bad password), or your browser
 
     wrong credentials (e.g., bad password), or your browser
 
     does not understand how to supply the credentials required.
 
     does not understand how to supply the credentials required.
 +
 +
'''Failure while trying to pass invalid account number'''
 +
:'''GET''' http(s)://{api_server}/accounts/fake/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju
 +
 +
''Response Code:''
 +
<pre>HTTP/1.1 404 Not Found</pre>
 +
 +
''Response Body:''
 +
<nowiki>
 +
{
 +
    "itemNotFound" : {
 +
      "message": "Resource not found",
 +
      "code": 404,
 +
      "details": "",
 +
      "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
 +
    }
 +
}</nowiki>
 +
 +
== Alternative URI /os-security-groups/{name} ==
 +
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].
 +
 +
<code>GET /os-security-groups/{name}</code>
  
 
[[Category:Hostway API]]
 
[[Category:Hostway API]]
 
[[Category:FlexCloud Server API]]
 
[[Category:FlexCloud Server API]]

Revision as of 14:58, 29 August 2013

This operation will list the details for the specified firewall group.

Contents

GET /accounts/{accountId}/flexcloud/os-security-groups/{id}

This operation will list the details for the specified firewall group.

Parameters

accountId - string
The selected account Id.
id
The unique identifier of the firewall group.

Response

JSON

 {
    "securityGroup" : {
       "displayName" : "{firewall_group_display_name}",
       "description" : "{firewall_group_description}",
       "links" : [
          {
             "href" : "http://{api-server}/accounts/{accountId}/flexcloud/os-security-groups/{firewall_group_name}/",
	     "rel" : "self"
          }
       ],
       "rules" : [
          {
             "fromPort" : "{start_port}",
	     "toPort" : "{end_port}",
             "protocol" : "{ip_protocol}",
             "cidr": "0.0.0.0/0",
	     "id" : "145"
	  },
          {
             "fromPort" : "{start_port}",
	     "toPort" : "{end_port}",
             "protocol" : "{ip_protocol}",
             "cidr": "127.0.0.1/0",
	     "id" : "169"
	  }
       ],
       "servers" : ["{server_id}"],
       "accountNumber" : "{user_account_number}",
       "id" : "{firewall_group_id}"
    }
 }

securityGroup

displayName - string
The display name of the firewall group.
description - string
Text describing the firewall group.
links - list
Hypermedia for this resource.
rules - list
List describing all defined security rules for the group.
servers - list
List of server ids this firewall group is assigned to.
accountNumber - string
Identifies an account that owns the firewall group.
id - string
The id of this firewall group.*(Unique identifier for this firewall group.)

Response Codes

Success
HTTP/1.1 200 OK
Failure
HTTP/1.1 401 Unauthorized : This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
HTTP/1.1 404 Not Found - The resource does not exist.

Examples

Successfully list details for specified firewall group

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 200 OK

Response Body:

 {
    "securityGroup" : {
       "displayName": "Test Firewall Group 1", 
       "description": "Test firewall group 1 description.", 
       "links": [
          {
             "href": "http://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju/", 
             "rel": "self"
          }
       ], 
       "rules": [ 
          {
             'toPort': 1111, 
             'fromPort': 1111, 
             'protocol': 'TCP', 
             'id': 145, 
             'cidr': '0.0.0.0/0'
          },
          {
             'toPort': 80, 
             'fromPort': 80, 
             'protocol': 'TCP', 
             'id': 196, 
             'cidr': '127.0.0.1/24'
          }
       ], 
       "id": "group2012May11_OK30Zs7Ju", 
       "accountNumber": "test_account_120761",
       "servers": ["test-server-0003"]
    }
 }

Failure while trying to request details for a firewall group that does not exist

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/{fake_firewall_group_name}

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 404 Not Found

Response Body:

{
   "itemNotFound": 
      {
         "message": "Resource not found", 
         "code": 404, 
         "details": "",
         "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
      }
}

Failure while trying to make unauthorized access

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded fake_authentication_string

Response Code:

HTTP/1.1 401 Unauthorized

Response Body:

    401 Unauthorized
    This server could not verify that you are authorized to
    access the document you requested.  Either you supplied the
    wrong credentials (e.g., bad password), or your browser
    does not understand how to supply the credentials required.

Failure while trying to pass invalid account number

GET http(s)://{api_server}/accounts/fake/flexcloud/os-security-groups/group2012May11_OK30Zs7Ju

Response Code:

HTTP/1.1 404 Not Found

Response Body:

 {
    "itemNotFound" : {
       "message": "Resource not found", 
       "code": 404, 
       "details": "",
       "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
    }
 }

Alternative URI /os-security-groups/{name}

An alternative way to execute this call is to omit the accountId portion of the URI. In this case the system assumes the request is executed for the account identified in the authorization header.

GET /os-security-groups/{name}

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox