Flavor

From Hostway API Documentation
Revision as of 07:08, 20 May 2013 by Mike.robski (Talk | contribs)
Jump to: navigation, search

This operation will return size details of a single flavor.

GET /flavors/detail/id

Contents

Parameters

id
The unique identifier of the flavor to be retrieved. Note see warnings in Hypermedia.

Result

JSON

 {
   "flavor":
      {
         "name":"{display_flavor_name}",
         "links":[
            {
               "href":"http://{api_server}/flavors/{flavor_id}/",
               "rel":"self"
            }
         ],
         "vcpu":"1",
         "ram":512,
         "disk":10,
         "id":"{flavor_id}"
      }
}

id - string
Unique identifier for this flavor.
links - array
Hypermedia for this resource.
name - string
Display name for this flavor.
ram - number
Memory allocated with this flavor. Specified in MB.
disk - number
Disk space allocated with this flavor. Specified in GB.
vcpu - number
Number of CPUs allocated with this flavor.

Response Codes

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 403 Forbidden - The resource cannot be accessed by the user
HTTP/1.1 404 Not Found' - The requested resource does not exist

Examples

Successfully view flavor details

GET http://{api_server}/flavors/1

Request Headers:

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

Response Code:

HTTP/1.1 200 OK

Response Body:

     {
       "flavor":
          {
             "name":"Small", 
             "links":[
                {
                  "href":"http://{api_server}/flavors/1/", 
                  "rel":"self"
                }
             ], 
             "vcpu":"1", 
             "ram":512, 
             "disk":10, 
             "id":"1"
           }
      }

Failure while trying to make an unauthorized request

GET http://{api_server}/flavors/{flavor_id}

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 access a flavor that is not allowed for this user

GET http://{api_server}/flavors/{flavor_id}

Request Headers:

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

Response Code:

HTTP/1.1 403 Forbidden

Response Body:

     {
        "forbidden":
        {
            "message": "forbidden",
            "code": 403,
            "details": "",
            "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
        }
     }


Failure while trying to access a flavor that does not exist

GET http(s)://{api_server}/flavors/{fake_flavor_id}

Request Headers:

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

Response Code:

HTTP/1.1 404 Not Found

Response Body:

     {
         "itemNotFound":
         {
             "message": "Resource not found",
             "code": 404,
             "details": "",
             "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
         }
     }
Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox