View Allocated Flexible IP - Revision history

Mike.robski: 1 revision: Release 86

2013-10-11T17:00:56Z

1 revision: Release 86

Emanuela.mitreva at 15:20, 11 July 2013

2013-07-11T15:20:52Z

Mike.robski: 1 revision

2013-05-24T15:24:59Z

1 revision

Mike.robski at 13:18, 20 May 2013

2013-05-20T13:18:34Z

Administrator at 01:32, 13 April 2013

2013-04-13T01:32:29Z

Mike.robski at 22:40, 14 December 2012

2012-12-14T22:40:08Z

Mike.robski at 20:37, 14 December 2012

2012-12-14T20:37:31Z

Administrator: Created page with "This operation will list details of the specific allocated flexible IP address. ='''GET''' /os-floating-ips/'''ip_address'''= List details of the specific allocated flexible ..."

2012-07-04T21:25:07Z

Created page with "This operation will list details of the specific allocated flexible IP address. ='''GET''' /os-floating-ips/'''ip_address'''= List details of the specific allocated flexible ..."

New page

This operation will list details of the specific allocated flexible IP address.

='''GET''' /os-floating-ips/'''ip_address'''=
List details of the specific allocated flexible IP address.

== Parameters ==
; ip_address - ''string''

== Response ==
=== JSON ===
<nowiki>
{
"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"
}
]
}
</nowiki>

====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:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
{
"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"
}
]
}
</nowiki>

'''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:''
<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 view details for a non-existent flexible IP address'''
:'''GET''' http(s)://{api_server}/os-floating-ips/{<span style="color:red">fake_ip_address</span>}

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

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

← Older revision		Revision as of 20:37, 14 December 2012
Line 113:		Line 113:
	<pre>HTTP/1.1 404 Not Found</pre>		<pre>HTTP/1.1 404 Not Found</pre>

		+
		+	[[Category: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-->

@@ Line 1: / Line 1: @@
 This operation will list details of the specific allocated flexible IP address.
-='''GET''' /os-floating-ips/'''ip_address'''=
+='''GET''' /accounts/''{accountId}''/flexcloud/os-floating-ips/''{ip_address}''=
 List details of the specific allocated flexible IP address.
 == Parameters ==
 ; ip_address - ''string''
@@ Line 18: / Line 21: @@
           "links": [
+             {
-                "href": "http://{api_server}/os-floating-ips/{ip_address}/",
+                "href": "http://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips/{ip_address}/",
                 "rel": "self"
+             }
@@ Line 25: / Line 28: @@
+       }
+    ]
 }</nowiki>
 </nowiki>
 ====floating_ip====
@@ Line 54: / Line 56: @@
 '''View detailed information for the specified allocated floating IP address'''
-:'''GET''' http(s)://{api_server}/os-floating-ips/{ip_address}
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips/{ip_address}
 ''Request Headers:''
@@ Line 74: / Line 76: @@
           "links": [
+             {
-                "href": "http://{api_server}/os-floating-ips/{ip_address}/",
+                "href": "http://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips/{ip_address}/",
                 "rel": "self"
+             }
@@ Line 81: / Line 83: @@
+        }
+    ]
   }</nowiki>
 </nowiki>
 '''Unauthorized access'''
-:'''GET''' http(s)://{api_server}/os-floating-ips/{ip_address}
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips/{ip_address}
 ''Request Headers:''
@@ Line 103: / Line 104: @@
 '''Failure while trying to view details for a non-existent flexible IP address'''
-:'''GET''' http(s)://{api_server}/os-floating-ips/{<span style="color:red">fake_ip_address</span>}
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/os-floating-ips/{<span style="color:red">fake_ip_address</span>}
 ''Request Headers:''
@@ Line 112: / Line 113: @@
 ''Response Code:''
 <pre>HTTP/1.1 404 Not Found</pre>
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]

@@ Line 1: / Line 1: @@
 This operation will list details of the specific allocated flexible IP address.
-=='''GET''' /os-floating-ips/'''ip_address'''==
+='''GET''' /os-floating-ips/'''ip_address'''=
-=== Parameters ===
+== Parameters ==
 ; ip_address - ''string''
-=== Response ===
+== Response ==
-==== JSON ====
+=== JSON ===
   <nowiki>
+{
@@ Line 27: / Line 28: @@
 </nowiki>
-=====floating_ip=====
+====floating_ip====
 ; instance_id - ''string''
 : Unique instance identifier floating IP is assigned to.
@@ Line 43: / Line 44: @@
 : Name of the pool IP address belongs to.
-=== Response Codes ===
+== Response Codes ==
 ; Success:
 :''HTTP/1.1 200 OK''
@@ Line 50: / Line 51: @@
 :''HTTP/1.1 404 Not Found'' - The resource does not exist
-=== Examples ===
+== Examples ==
 '''View detailed information for the specified allocated floating IP address'''
@@ Line 114: / Line 115: @@
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]