Mike.robski: 1 revision: Release 109

2015-07-24T18:12:59Z

1 revision: Release 109

Jerry.dimitrov at 16:46, 20 April 2015

2015-04-20T16:46:20Z

New page

This operation lists existing firewall groups.

='''GET''' /accounts/''{accountId}''/os-security-groups=
This operation lists existing firewall groups.

== Request ==
==== Request Parameters ====
; accountId - ''string''
: The selected account Id.

== Response ==
=== JSON ===
<nowiki>
{
"securityGroups" : [
{
"displayName" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}",
"links" : [
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-groups/{firewall_group_id}/",
"rel" : "self"
}
],
"rules" : [
{
"fromPort" : {start_port},
"toPort" : {end_port},
"protocol" : "{ip_protocol}",
"cidr": "0.0.0.0/0",
"id" : "145"
}
]
"servers" : ["{server_id}"],
"accountNumber" : "{user_account_number}",
"Id" : "{firewall_group_id}"
}
]
}</nowiki>

====security_groups====
; 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.

; fault - ''dictionary''
: Might hold a fault information for the firewall 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 firewall groups'''
:'''GET''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups

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

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
{
"securityGroup" : [
{
"displayName": "Test Firewall Group 1",
"description": "Test firewall group 1 description.",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/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"]
},
{
"displayName": "Test Firewall Group",
"description": "Test firewall group description.",
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/os-security-groups/group2012Apr30_9J5qDwOIo/",
"rel": "self"
}
],
"rules": [
{
'toPort': 3389,
'fromPort': 3389,
'protocol': 'tcp',
'id': 116,
'cidr': '0.0.0.0/0'
},
{
'toPort': 8443,
'fromPort': 8443,
'protocol': 'tcp',
'id': 117,
'cidr': '0.0.0.0/0'
},
{
'toPort': 22,
'fromPort': 22,
'protocol': 'tcp',
'id': 118,
'cidr': '0.0.0.0/0'
}
],
"id": "group2012Apr30_9J5qDwOIo",
"accountNumber": "test_account_901265",
"servers": ["test-server-0011", "test-server-0024"]
}
}
}</nowiki>

'''Failure while trying to make unauthorized access'''
:'''POST''' {{APIBaseURL}}/accounts/{accountId}/os-security-groups

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded <span style="color:red">fake_authentication_string</span>

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''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'''
:'''POST''' {{APIBaseURL}}/accounts/fakeId/os-security-groups

''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 /accounts/os-security-groups ==
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 /accounts/os-security-groups</code>

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

Accounts-accountId-os-security-groups:GET - Revision history

Mike.robski: 1 revision: Release 109

Jerry.dimitrov at 16:46, 20 April 2015