ServerList - Revision history

Mike.robski: 1 revision: Release 98

2014-09-15T13:52:11Z

1 revision: Release 98

Donghyun.kim: /* Parameters */

2014-08-22T21:56:18Z

Parameters

Mike.robski: 1 revision: Release 90

2014-01-31T18:24:45Z

1 revision: Release 90

Donghyun.kim: /* Parameters */

2014-01-28T23:07:22Z

Parameters

Mike.robski: 1 revision: Release 86

2013-10-11T17:00:54Z

1 revision: Release 86

Emanuela.mitreva: /* Response Codes */

2013-07-11T16:36:56Z

Response Codes

Administrator at 00:56, 27 June 2013

2013-06-27T00:56:24Z

Mike.robski: 1 revision

2013-05-24T15:24:58Z

1 revision

Mike.robski at 13:10, 20 May 2013

2013-05-20T13:10:01Z

Administrator at 01:03, 13 April 2013

2013-04-13T01:03:37Z

@@ Line 11: / Line 11: @@
 ; status - ''string''
-: Server status to search for. Values: '''BUILD''', '''ACTIVE''', '''SUSPENDED''', '''DELETED''', '''STOPPED'''
+: Server status to search for. Values: '''BUILD''', '''ACTIVE''', '''SUSPENDED''', '''DELETED''', '''STOPPED''', '''PROCESSING'''
-: without status filtering, return servers with '''ACTIVE''' or '''STOPPED'''
+: without status filtering, return servers with '''ACTIVE''', '''PROCESSING''' or '''STOPPED'''
 ; image - ''string''

@@ Line 1: / Line 1: @@
 This operation returns a list of all [[Server|servers]].
-='''GET''' /accounts/''{accountId}''/flexcloud/servers?''name=serverName&status=serverStatus&image=imageRef&zone=zoneTextKey''=
+='''GET''' /accounts/''{accountId}''/flexcloud/servers?''name=serverName&status=serverStatus&image=imageRef&zone=zoneTextKey&region=regionTextKey''=
 == Parameters ==
@@ Line 11: / Line 11: @@
 ; status - ''string''
-: ''Optional'' Server status to search for. Values: '''BUILD''', '''ACTIVE''', '''SUSPENDED''', '''DELETED''', '''UNKNOWN'''
+: Server status to search for. Values: '''BUILD''', '''ACTIVE''', '''SUSPENDED''', '''DELETED''', '''STOPPED'''
 ; image - ''string''
@@ Line 18: / Line 19: @@
 ; zone - ''string''
 : ''Optional'' Zone textkey
 == Result ==

@@ Line 1: / Line 1: @@
-This operation will return a list of all [[Server|servers]].
+This operation returns a list of all [[Server|servers]].
-='''GET''' /servers?''name=serverName&status=serverStatus&image=imageRef&zone=zoneTextKey''=
+='''GET''' /accounts/''{accountId}''/flexcloud/servers?''name=serverName&status=serverStatus&image=imageRef&zone=zoneTextKey''=
 == Parameters ==
 ; name - ''string''
 : ''Optional'' Server name to search for.
@@ Line 26: / Line 29: @@
           "links":[
+             {
-                "href":"http://{api_server}/servers/{server_id}/",
+                "href":"http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/",
                 "rel":"self"
+             }
@@ Line 36: / Line 39: @@
           "links":[
+             {
-                "href":"http://{api_server}/servers/{server_id}/",
+                "href":"http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/",
                 "rel":"self"
+             }
@@ Line 59: / Line 62: @@
 ; 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 servers'''
-:'''GET''' http(s)://{api_server}/servers
+:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers
@@ Line 82: / Line 86: @@
            "links": [
+              {
-                 "href": "http://{api_server}/servers/test_server_0001/",
+                 "href": "http://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0001/",
                  "rel": "self"
+              }
@@ Line 92: / Line 96: @@
            "links": [
+              {
-                 "href": "http://{api_server}/servers/test_server_0013/",
+                 "href": "http://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/",
                  "rel": "self"
+              }
@@ Line 102: / Line 106: @@
            "links": [
+              {
-                 "href": "http://{api_server}/servers/test_server_0015/",
+                 "href": "http://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0015/",
                  "rel": "self"
+              }
@@ Line 111: / Line 115: @@
 '''Failure while trying to make unauthorized access'''
-:'''GET''' <nowiki>http://{api_server}/servers</nowiki>
+:'''GET''' <nowiki>http://{api_server}/accounts/{accountId}/flexcloud/servers</nowiki>
 ''Request Headers:''
@@ Line 127: / Line 131: @@
       wrong credentials (e.g., bad password), or your browser
       does not understand how to supply the credentials required.
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]

← Older revision		Revision as of 00:56, 27 June 2013
Line 1:		Line 1:
−	This operation ~~returns~~ a list of all [[Server\|servers]].	+	This operation will return a list of all [[Server\|servers]].

	='''GET''' /servers?''name=serverName&status=serverStatus&image=imageRef&zone=zoneTextKey''=		='''GET''' /servers?''name=serverName&status=serverStatus&image=imageRef&zone=zoneTextKey''=

@@ Line 1: / Line 1: @@
-This operation will list all [[Server|servers]].
+This operation returns a list of all [[Server|servers]].
-=='''GET''' /servers?''name=serverName&status=serverStatus&image=imageRef''==
+='''GET''' /servers?''name=serverName&status=serverStatus&image=imageRef&zone=zoneTextKey''=
-=== Parameters ===
+== Parameters ==
 ; name - ''string''
 : ''Optional'' Server name to search for.
@@ Line 13: / Line 13: @@
 : ''Optional'' Absolute URL of the image to filter servers by. ''e.g. http(s)://{api_server}/images/{image_id}/''
-=== Result ===
+; zone - ''string''
-==== JSON ====
+: ''Optional'' Zone textkey
   <nowiki>
+{
@@ Line 20: / Line 23: @@
+       {
           "id":"{server_id}",
           "links":[
+             {
@@ Line 29: / Line 33: @@
+       {
           "id":"{server_id}",
           "links":[
+             {
@@ Line 41: / Line 46: @@
 ; id - ''string''
 : Unique identifier for this server.
 ; links - ''array''
 : [[Hypermedia]] for this resource.
-=== Response Codes ===
+== Response Codes ==
 ; Success:
 :''HTTP/1.1 200 OK''
@@ Line 52: / Line 60: @@
 :''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 ===
+== Examples ==
 '''Successfully list servers'''
 :'''GET''' http(s)://{api_server}/servers
@@ Line 70: / Line 78: @@
      "servers" : [
+        {
            "id": "test_server_0001",
            "links": [
+              {
@@ Line 79: / Line 88: @@
         },
+        {
            "id": "test_server_0013",
            "links": [
+              {
@@ Line 88: / Line 98: @@
         },
+        {
            "id": "test_server_0015",
            "links": [
+              {
@@ Line 119: / Line 130: @@
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]

← Older revision		Revision as of 01:03, 13 April 2013
Line 1:		Line 1:
−	This operation ~~returns a~~ list of all [[Server\|servers]].	+	This operation will list all [[Server\|servers]].

	=='''GET''' /servers?''name=serverName&status=serverStatus&image=imageRef''==		=='''GET''' /servers?''name=serverName&status=serverStatus&image=imageRef''==