List Firewall Groups
(Difference between revisions)
Mike.robski (Talk | contribs) |
|||
| Line 1: | Line 1: | ||
| − | This operation | + | This operation will list all existing firewall groups. |
=='''GET''' /os-security-groups== | =='''GET''' /os-security-groups== | ||
Revision as of 20:38, 12 April 2013
This operation will list all existing firewall groups.
Contents |
GET /os-security-groups
This operation lists existing firewall groups.
Response
JSON
{
"security_groups" : [
{
"display_name" : "{firewall_group_display_name}",
"description" : "{firewall_group_description}",
"links" : [
{
"href" : "http://{api-server}/os-security-groups/{firewall_group_name}/",
"rel" : "self"
}
],
"rules" : [
{
"fromport" : {start_port},
"toport" : {end_port},
"protocol" : "{ip_protocol}",
"cidrIp": "0.0.0.0/0",
"id" : "145"
}
]
"fault" : {
"message" : "",
"code" : "",
"details" : ""
},
"servers" : ["{server_id}"],
"account_number" : "{user_account_number}",
"name" : "{firewall_group_name}"
}
]
}
security_groups
- display name - 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.
- account_number - string
- Identifies an account that owns the firewall group.
- name - string
- The name 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.
Examples
Successfully list firewall groups
- GET http(s)://{api_server}/os-security-groups
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Response Code:
HTTP/1.1 200 OK
Response Body:
{
"security_group" : [
{
"display_name": "Test Firewall Group 1",
"description": "Test firewall group 1 description.",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012May11_OK30Zs7Ju/",
"rel": "self"
}
],
"rules": [
{
'toport': 1111,
'fromport': 1111,
'protocol': 'TCP',
'id': 145,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 80,
'fromport': 80,
'protocol': 'tcp',
'id': 196,
'cidrIp': '127.0.0.1/24'
}
],
"name": "group2012May11_OK30Zs7Ju",
"account_number": "test_account_120761",
"servers": ["test-server-0003"]
},
{
"display_name": "Test Firewall Group",
"description": "Test firewall group description.",
"links": [
{
"href": "http://{api_server}/os-security-groups/group2012Apr30_9J5qDwOIo/",
"rel": "self"
}
],
"rules": [
{
'toport': 3389,
'fromport': 3389,
'protocol': 'tcp',
'id': 116,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 8443,
'fromport': 8443,
'protocol': 'tcp',
'id': 117,
'cidrIp': '0.0.0.0/0'
},
{
'toport': 22,
'fromport': 22,
'protocol': 'tcp',
'id': 118,
'cidrIp': '0.0.0.0/0'
}
],
"name": "group2012Apr30_9J5qDwOIo",
"account_number": "test_account_901265",
"servers": ["test-server-0011", "test-server-0024"]
}
}
}
Failure while trying to make unauthorized access
- POST http(s)://{api_server}/os-security-groups
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.
