FlavorList

Revision as of 15:29, 14 December 2012

This operation will list all available flavors optionally limited by the query parameters.

GET /flavors?minDisk=diskInGB&minRam=ramInMB

Parameters

minDisk - int

Optional Only flavors with a disk size greater than or equal to minDisk will be returned. Specified in GB.

minRam - int

Optional Only flavors with a memory size greater than or equal to minRam will be returned. Specified in MB.

Also see Pagination

Result

JSON

{
   "flavors":[
      {
         "id":"{flavor_id}",
         "links":[
            {
               "href":"http://{api_server}/flavors/{flavor_id}/",
               "rel":"self"
            }
         ],
         "name":"{display_flavor_name}"
      },
      {
         "id":"{flavor_id}",
         "links":[
            {
               "href":"http://{api_server}/flavors/{flavor_id}/",
               "rel":"self"
            }
         ],
         "name":"{display_flavor_name}"
      }
   ]
}

id - string

Unique identifier for this flavor.

links - array

Hypermedia for this resource.

name - string

Display name for this flavor.

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.

Examples

Successfully list available flavors

GET http://{api_server}/flavors

Request Headers:

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

Response Code:

HTTP/1.1 200 OK

Response Body:

     {
       "flavors": [
          {
            "name": "Small", 
            "links": [
               {
                 "href": "http://{api_server}/flavors/1/", 
                 "rel": "self"
               }, 
               {
                 "href":  "http://{api_server}/flavors/1/", 
                 "rel": "bookmark"
               }
            ], 
            "id": "1"
          },
          {
            "name": "Large", 
            "links": [
               {
                  "href": "<nowiki>http://{api_server}/flavors/3/", 
                 "rel": "self"
              }, 
              {
                 "href": "http://{api_server}/flavors/3/", 
                  "rel": "bookmark"}
            ],
            "id": "3"
          }
       ]
    }
 

Failure while trying to make an unauthorized request

GET http://{api_server}/flavors

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.