Server

(Difference between revisions)
Jump to: navigation, search
Line 2: Line 2:
 
Other types of operations on a server are: [[ServerCreate]], [[ServerActions]], etc.
 
Other types of operations on a server are: [[ServerCreate]], [[ServerActions]], etc.
  
='''GET''' /servers/'''id'''=
+
=='''GET''' /servers/'''id'''==
 
This operation will return details of a single server.
 
This operation will return details of a single server.
  
== Parameters ==
+
=== Parameters ===
 
; id - ''string''
 
; id - ''string''
 
: Id of the server to get.
 
: Id of the server to get.
  
== Result ==
+
=== Result ===
=== JSON ===
+
==== JSON ====
 
  <nowiki>
 
  <nowiki>
 
{
 
{
Line 72: Line 72:
 
}</nowiki>
 
}</nowiki>
  
==== server ====
+
===== server =====
 
; id - ''string''
 
; id - ''string''
 
: Unique identifier for this server.
 
: Unique identifier for this server.
Line 115: Line 115:
 
: Unused always null.
 
: Unused always null.
  
==== addresses ====
+
===== addresses =====
 
; addresses.public.version - ''number''
 
; addresses.public.version - ''number''
 
: IP version of this address. Values: '''4'''
 
: IP version of this address. Values: '''4'''
Line 128: Line 128:
 
: Private IP address of this server
 
: Private IP address of this server
  
==== image ====
+
===== image =====
 
; image.name - ''string''
 
; image.name - ''string''
 
: The display name of the image this server is based on.
 
: The display name of the image this server is based on.
Line 138: Line 138:
 
: Unique identifier for image this server is based on.
 
: Unique identifier for image this server is based on.
  
==== flavor ====
+
===== flavor =====
 
; flavor.name - ''string''
 
; flavor.name - ''string''
 
: The display name of the flavor this server is based on.
 
: The display name of the flavor this server is based on.
Line 148: Line 148:
 
: Unique identifier for flavor this server is based on.
 
: Unique identifier for flavor this server is based on.
  
== Response Codes ==
+
=== Response Codes ===
 
; Success:OK (200)
 
; Success:OK (200)
  
Line 156: Line 156:
  
  
== Examples ==
+
=== Examples ===
 
'''Successfully get server details'''
 
'''Successfully get server details'''
 
:'''GET''' http(s)://{api_server}/servers/test_server_0013
 
:'''GET''' http(s)://{api_server}/servers/test_server_0013
Line 241: Line 241:
 
  }
 
  }
  
='''PUT''' /servers/'''id'''=
+
=='''PUT''' /servers/'''id'''==
 
This operation will update details of a single server.
 
This operation will update details of a single server.
  
== Parameters ==
+
=== Parameters ===
 
; id - ''string''
 
; id - ''string''
 
: Id of the server to update.
 
: Id of the server to update.
  
====server attributes====
+
=====server attributes=====
 
; name - ''string'' : New display server name to update
 
; name - ''string'' : New display server name to update
  
== Request==
+
=== Request===
=== JSON ===
+
==== JSON ====
 
  <nowiki>
 
  <nowiki>
 
  {  
 
  {  
Line 261: Line 261:
 
  } </nowiki>
 
  } </nowiki>
  
== Response==
+
=== Response===
=== JSON ===
+
==== JSON ====
 
  <nowiki>
 
  <nowiki>
 
{
 
{
Line 324: Line 324:
 
}</nowiki>
 
}</nowiki>
  
== Response Codes ==
+
=== Response Codes ===
 
; Success
 
; Success
 
: ''HTTP/1.1 200 OK''
 
: ''HTTP/1.1 200 OK''
Line 334: Line 334:
 
: ''HTTP/1.1 405 Method Not Allowed'' : Unsupported server attribute.
 
: ''HTTP/1.1 405 Method Not Allowed'' : Unsupported server attribute.
  
='''DELETE''' /servers/'''id'''=
+
=='''DELETE''' /servers/'''id'''==
 
This operation will delete a single server.
 
This operation will delete a single server.
  
== Parameters ==
+
=== Parameters ===
 
; id - ''string''
 
; id - ''string''
 
: Id of the server to delete.
 
: Id of the server to delete.
  
== Response Codes ==
+
=== Response Codes ===
 
; Success
 
; Success
 
: ''HTTP/1.1 202 Accepted'' or ''HTTP/1.1 204 No Content''
 
: ''HTTP/1.1 202 Accepted'' or ''HTTP/1.1 204 No Content''
Line 349: Line 349:
 
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.
 
: ''HTTP/1.1 404 Not Found'' : The resource requested is not found.
  
== Examples ==
+
=== Examples ===
 
'''Successfully delete a specific server'''
 
'''Successfully delete a specific server'''
 
:'''DELETE''' http(s)://{api_server}/servers/123
 
:'''DELETE''' http(s)://{api_server}/servers/123
Line 362: Line 362:
 
<pre>HTTP/1.1 404 Not Found</pre>
 
<pre>HTTP/1.1 404 Not Found</pre>
  
[[Category:API]]
+
[[Category:Hostway 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:39, 14 December 2012

This article describes operations for getting details of servers, along with updating and deleting servers in your account. Other types of operations on a server are: ServerCreate, ServerActions, etc.

Contents

GET /servers/id

This operation will return details of a single server.

Parameters

id - string
Id of the server to get.

Result

JSON

{
   "server":{
      "status":"ACTIVE",
      "updated":null,
      "hostId":"{host_id}",
      "addresses":{
         "public":[
            {
               "version":4,
               "addr":"{ip_address}"
            }
         ],
         "private":[
            {
               "version":4,
               "addr":"{ip_address}"
            }
         ]
      },
      "links":[
         {
            "href":"http://{api_server}/servers/{server_id}/",
            "rel":"self"
         }
      ],
      "image":{
         "name":"{display_image_name}",
         "links":[
            {
               "href":"http://{api_server}/images/{image_id}/",
               "rel":"self"
            }
         ],
         "id":"{image_id}"
      },
      "userId":"{user_account_id}",
      "flavor":{
         "name":"1024MB Server3",
         "links":[
            {
               "href":"http://{api_server}/flavors/{flavor_id}/",
               "rel":"self"
            }
         ],
         "id":3
      },
      "id":"{server_id}",
      "name":"{display_server_name}",
      "adminPass":null,
      "created":"2011-12-05T12:51:28",
      "tenantId":null,
      "accessIPv4":"{ip_address}",
      "accessIPv6":null,
      "progress":100,
      "metadata":{

      }
   }
}
server
id - string
Unique identifier for this server.
links - list
Hypermedia for this resource.
status - string
Current state of the server. Values: BUILD, ACTIVE, SUSPENDED, DELETED, UNKNOWN
hostId - string
Id of the physical host this virtual machine is running on.
userId - string
Unique identifier for the owner of this server.
name - string
Display name for this server.
adminPass - string
always null.
created - string
The date and time this server was created. ISO 8601 format, YYYY-MM-DDTHH:MM:SS.
accessIPv4 - string
The default included public IPv4 address.
progress - number
The progress of the current this server while in the BUILD status. The value is in the range of 0 - 100, but currently will only even be 0, 50, 100.
metadata - object
Unused always an empty object.
tenantId
Unused always always null.
accessIPv6
Unused always null.
updated
Unused always null.
addresses
addresses.public.version - number
IP version of this address. Values: 4
addresses.public.addr = string
Public IP address of this server
addresses.private.version - number
IP version of this address. Values: 4
addresses.private.addr - string
Private IP address of this server
image
image.name - string
The display name of the image this server is based on.
image.links - list
Hypermedia for the image.
image.id - string
Unique identifier for image this server is based on.
flavor
flavor.name - string
The display name of the flavor this server is based on.
flavor.links - list
Hypermedia for the flavor.
flavor.id - string
Unique identifier for flavor this server is based on.

Response Codes

Success
OK (200)
Failure

-Unauthorized (401) : 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. -ItemNotFound (404) : The resource requested is not found.


Examples

Successfully get server details

GET http(s)://{api_server}/servers/test_server_0013

- Request Headers:

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

- Response: OK (200):

 {
    "server": 
       {
          "status": "ACTIVE", 
          "updated": null, 
          "hostId": "{host_id}", 
          "addresses": 
             {
                "public": [
                   {
                      "version": 4, 
                      "addr": "{ip_address}"
                   }
                ], 
                "private": [
                   {
                      "version": 4, 
                      "addr":  "{ip_address}"
                   }
                ]
             }, 
          "links": [
             {
                "href": "http://{api_server}/servers/test_server_0013/", 
                "rel": "self"
             }
          ], 
          "image": {
             "name": "CentOS 5 Plesk", 
             "links": [
                {
                   "href": "http://{api_server}/images/test_public_image/", 
                   "rel": "self"
                }
             ], 
             "id": "test_public_image" 
          }, 
          "userId": "{user_account_id}", 
          "flavor":  {"name": "", "links": [], "id": ""}, 
          "id": "test_server_0013", 
          "name": "test_server_created", 
          "adminPass": null,
          "created": "2011-11-25T12:16:47", 
          "tenantId": null, 
          "accessIPv4": "{ip_address}", 
          "accessIPv6": null, 
          "progress": 100, 
          "metadata": {}
    }
 } 
  • When a server is in pending status (has not completed the provisioning process), the creation timestamp and hostId that are returned will be empty strings.

Failure while trying to get server details without proper authorization - Response: Unauthorized (401):

    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 get server details for a non-existent server id - Response: ItemNotFound (404):

{
   "itemNotFound": 
      {
         "message": "Resource not found", 
         "code": 404, 
         "details": ""
      }
}

PUT /servers/id

This operation will update details of a single server.

Parameters

id - string
Id of the server to update.
server attributes
name - string 
New display server name to update

Request

JSON

 { 
    "server" : 
       {
          "name" : "{new_display_name}" 
       }
 } 

Response

JSON

{
   "server":{
      "status":"ACTIVE",
      "updated":null,
      "hostId":"{host_id}",
      "addresses":{
         "public":[
            {
               "version":4,
               "addr":"{ip_address}"
            }
         ],
         "private":[
            {
               "version":4,
               "addr":"{ip_address}"
            }
         ]
      },
      "links":[
         {
            "href":"http://{api_server}/servers/{server_id}/",
            "rel":"self"
         }
      ],
      "image":{
         "name":"{display_image_name}",
         "links":[
            {
               "href":"http://{api_server}/images/{image_id}/",
               "rel":"self"
            }
         ],
         "id":"{image_id}"
      },
      "userId":"{user_account_id}",
      "flavor":{
         "name":"1024MB Server3",
         "links":[
            {
               "href":"http://{api_server}/flavors/{flavor_id}/",
               "rel":"self"
            }
         ],
         "id":3
      },
      "id":"{server_id}",
      "name":"{new_display_name}",
      "adminPass":null,
      "created":"2011-12-05T12:51:28",
      "tenantId":null,
      "accessIPv4":"{ip_address}",
      "accessIPv6":null,
      "progress":100,
      "metadata":{

      }
   }
}

Response Codes

Success
HTTP/1.1 200 OK
Failure
HTTP/1.1 400 Bad Request : Display name in use. / Display name invalid.
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 requested is not found.
HTTP/1.1 405 Method Not Allowed : Unsupported server attribute.

DELETE /servers/id

This operation will delete a single server.

Parameters

id - string
Id of the server to delete.

Response Codes

Success
HTTP/1.1 202 Accepted or HTTP/1.1 204 No Content
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 requested is not found.

Examples

Successfully delete a specific server

DELETE http(s)://{api_server}/servers/123

Response Code:

HTTP/1.1 202 Accepted

Failure while trying to update a non-existent server

DELETE http(s)://{api_server}/servers/{fake_server_id}

Response Code:

HTTP/1.1 404 Not Found


blog comments powered by Disqus


Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox