View Allocated Flexible IP
(Difference between revisions)
Mike.robski (Talk | contribs) |
Mike.robski (Talk | contribs) |
||
| Line 1: | Line 1: | ||
| + | =='''GET''' /os-floating-ips/'''ip_address'''== | ||
This operation will list details of the specific allocated flexible IP address. | This operation will list details of the specific allocated flexible IP address. | ||
| − | |||
| − | |||
List details of the specific allocated flexible IP address. | List details of the specific allocated flexible IP address. | ||
| − | == Parameters == | + | === Parameters === |
; ip_address - ''string'' | ; ip_address - ''string'' | ||
| − | == Response == | + | === Response === |
| − | === JSON === | + | ==== JSON ==== |
<nowiki> | <nowiki> | ||
{ | { | ||
| Line 28: | Line 27: | ||
</nowiki> | </nowiki> | ||
| − | ====floating_ip==== | + | =====floating_ip===== |
; instance_id - ''string'' | ; instance_id - ''string'' | ||
: Unique instance identifier floating IP is assigned to. | : Unique instance identifier floating IP is assigned to. | ||
| Line 44: | Line 43: | ||
: Name of the pool IP address belongs to. | : Name of the pool IP address belongs to. | ||
| − | == Response Codes == | + | === Response Codes === |
; Success: | ; Success: | ||
:''HTTP/1.1 200 OK'' | :''HTTP/1.1 200 OK'' | ||
| Line 51: | Line 50: | ||
:''HTTP/1.1 404 Not Found'' - The resource does not exist | :''HTTP/1.1 404 Not Found'' - The resource does not exist | ||
| − | == Examples == | + | === Examples === |
'''View detailed information for the specified allocated floating IP address''' | '''View detailed information for the specified allocated floating IP address''' | ||
| Line 113: | Line 112: | ||
<pre>HTTP/1.1 404 Not Found</pre> | <pre>HTTP/1.1 404 Not Found</pre> | ||
| − | + | [[Category:Hostway API]] | |
| − | [[Category:API]] | + | [[Category:FlexCloud Server API]] |
<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING--> | <!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING--> | ||
Revision as of 16:40, 14 December 2012
Contents |
GET /os-floating-ips/ip_address
This operation will list details of the specific allocated flexible IP address. List details of the specific allocated flexible IP address.
Parameters
- ip_address - string
Response
JSON
{
"floating_ip" : [
{
"instance_id" : {instance_id},
"ip": "{ip_address}",
"fixed_ip": null,
"links": [
{
"href": "http://{api_server}/os-floating-ips/{ip_address}/",
"rel": "self"
}
],
"pool": "default"
}
]
}
floating_ip
- instance_id - string
- Unique instance identifier floating IP is assigned to.
- ip - string
- IP address allocated.
- fixed_ip - string
- Fixed IP address.
- links - list
- Hypermedia for this resource.
- pool - string
- Name of the pool IP address belongs to.
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
View detailed information for the specified allocated floating IP address
- GET http(s)://{api_server}/os-floating-ips/{ip_address}
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Response Code:
HTTP/1.1 200 OK
Response Body:
{
"floating_ip" : [
{
"instance_id": "test_server_0013",
"ip": "{ip_address}",
"fixed_ip": null,
"links": [
{
"href": "http://{api_server}/os-floating-ips/{ip_address}/",
"rel": "self"
}
],
"pool": "default"
}
]
}
Unauthorized access
- GET http(s)://{api_server}/os-floating-ips/{ip_address}
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 view details for a non-existent flexible IP address
- GET http(s)://{api_server}/os-floating-ips/{fake_ip_address}
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Response Code:
HTTP/1.1 404 Not Found
