FlavorListDetails

Revision as of 18:54, 12 April 2013

This operation will list all available flavors with their size details optionally limited by the query parameters.

GET /flavors/detail?minDisk=diskInGB&minRam=ramInMB

Parameters

minDisk - int

Optional Only flavors only 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":[
      {
         "name":"{display_flavor_name}",
         "links":[
            {
               "href":"http://{api_server}/flavors/{flavor_id}/",
               "rel":"self"
            }
         ],
         "vcpu":1,
         "ram":512,
         "disk":10,
         "id":"{flavor_id}"
      },
      {
         "name":"{display_flavor_name}",
         "links":[
            {
               "href":"http://{api_server}/flavors/{flavor_id}/",
               "rel":"self"
            }
         ],
         "vcpu":4,
         "ram":16384,
         "disk":60,
         "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

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 flavors with details

GET {api_server}/flavors/detail

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"
            }
         ],
         "vcpu":1,
         "ram":512,
         "disk":10,
         "id":"1"
       },
       {
         "name":"Large",
         "links":[
            {
               "href":"http://{api_server}/flavors/2/",
               "rel":"self"
            }
         ],
         "vcpu":4,
         "ram":16384,
         "disk":60,
         "id":"2"
       }
    ]
  }

Failure while trying to make an unauthorized request

GET {api_server}/flavors/detail

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.