From Hostway API Documentation

Jump to: navigation, search

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.

GET /accounts/{accountId}/flexcloud/servers/{id}

This operation will return details of a single server.

Parameters

accountId - string: The selected account Id.

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}/accounts/{accountId}/flexcloud/servers/{server_id}/",
            "rel":"self"
         }
      ],
      "image":{
         "name":"{display_image_name}",
         "links":[
            {
               "href":"http://{api_server}/accounts/{accountId}/flexcloud/images/{image_id}/",
               "rel":"self"
            }
         ],
         "id":"{image_id}"
      },
      "userId":"{user_account_id}",
      "flavor":{
         "name":"1024MB Server3",
         "links":[
            {
               "href":"http://{api_server}/accounts/{accountId}/flexcloud/flavors/{flavor_id}/",
               "rel":"self"
            }
         ],
         "id":3
      },
      "securityGroup":{
         "id":"{security_group_id}",
         "links":[
            {
               "href":"http://{server_name}/accounts/{accountId}/flexcloud/os-security-groups/{security_group_id}/",
               "rel":"self"
            }
         ]
      },
      "id":"{server_id}",
      "zone": "{zone_textkey}",
      "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, PROCESSING, 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.

zone: Zone text key

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.

securityGroup

securityGroup.id - string: the id of the security group that is assigned to this server

securityGroup.links - list: Hypermedia for the securityGroup.

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}/accounts/{accountId}/flexcloud/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}/accounts/{accountId}/flexcloud/servers/test_server_0013/", 
                "rel": "self"
             }
          ], 
          "image": {
             "name": "CentOS 5 Plesk", 
             "links": [
                {
                   "href": "http://{api_server}/accounts/{accountId}/flexcloud/images/test_public_image/", 
                   "rel": "self"
                }
             ], 
             "id": "test_public_image" 
          }, 
          "securityGroup":{
             "id":"group2012Nov02_jD6NX8BsK",
             "links":[
                {
                   "href":"http://{server_name}/accounts/{accountId}/flexcloud/os-security-groups/group2012Nov02_jD6NX8BsK/",
                   "rel":"self"
                }
             ]
          },
          "userId": "{user_account_id}", 
          "flavor":  {"name": "", "links": [], "id": ""}, 
          "id": "test_server_0013",
          "zone": "AUS001",
          "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 or passing invalid account number - Response: ItemNotFound (404):

{
    "itemNotFound": 
       {
          "message": "Resource not found", 
          "code": 404, 
          "details": "",
          "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
       }
 }

PUT /accounts/{accountId}/flexcloud/servers/{id}

This operation will update details of a single server.

Parameters

accountId - string: The selected account Id.

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}/accounts/{accountId}/flexcloud/servers/{server_id}/",
            "rel":"self"
         }
      ],
      "image":{
         "name":"{display_image_name}",
         "links":[
            {
               "href":"http://{api_server}/accounts/{accountId}/flexcloud/images/{image_id}/",
               "rel":"self"
            }
         ],
         "id":"{image_id}"
      },
      "securityGroup": {
         "id":"{security_group_id}",
         "links":[
            {
               "href":"http://{api_server}/accounts/{accountId}/flexcloud/os-security-groups/{security_group_id}/",
               "rel":"self"
            }
         ]
      },
      "userId":"{user_account_id}",
      "flavor":{
         "name":"1024MB Server3",
         "links":[
            {
               "href":"http://{api_server}/accounts/{accountId}/flexcloud/flavors/{flavor_id}/",
               "rel":"self"
            }
         ],
         "id":3
      },
      "id":"{server_id}",
      "zone": "AUS001",
      "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 /accounts/{accountId}/flexcloud/servers/{id}

This operation will delete a single server.

Parameters

accountId - string: The selected account Id.

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}/accounts/{accountId}/flexcloud/servers/123

Response Code:

HTTP/1.1 202 Accepted

Failure while trying to update a non-existent server

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

Response Code:

HTTP/1.1 404 Not Found

Failure while trying to pass invalid account number

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

Response Code:

HTTP/1.1 404 Not Found

Alternative URI /servers/{id}

An alternative way to execute this call is to omit the accountId portion of the URI. In this case the system assumes the request is executed for the account identified in the authorization header.

GET /servers/{id}

Server

Contents

GET /accounts/{accountId}/flexcloud/servers/{id}

Parameters

Result

JSON

server

addresses

image

flavor

securityGroup

Response Codes

Examples

PUT /accounts/{accountId}/flexcloud/servers/{id}

Parameters

server attributes

Request

JSON

Response

JSON

Response Codes

DELETE /accounts/{accountId}/flexcloud/servers/{id}

Parameters

Response Codes

Examples

Alternative URI /servers/{id}

Personal tools

Namespaces

Variants

Views

Actions

Search

APIs

Navigation

Toolbox