FlavorListDetails
From Hostway API Documentation
Revision as of 11:29, 24 May 2013 by Mike.robski (Talk | contribs)
GET /flavors/detail?minDisk={diskInGB}&minRam={ramInMB}
This operation will list all available flavors with size details optionally limited by the query parameters.
Contents |
Request
GET /flavors/detail?minDisk={diskInGB}&minRam={ramInMB}
URI 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
Response
Status Code
- 200 OK
- Success
- 401 Unauthorized
- Failure - 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.
Response Body
{
"flavors":[
{
"name":"{display_flavor_name}",
"links":[
{"href":"https://api.hostway.com/flavors/{flavor_id}/", "rel":"self"}
],
"vcpu":1,
"ram":512,
"disk":10,
"id":"{flavor_id}"
},
{
"name":"{display_flavor_name}",
"links":[
{"href":"https://api.hostway.com/flavors/{flavor_id}/", "rel":"self"}
],
"vcpu":4,
"ram":16384,
"disk":60,
"id":"{flavor_id}"
}
]
}
Parameters
- 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.
Examples
Successfully list flavors with details
Request
GET /flavors/detail
Authorization: Basic {Base64-encoded username:password string}
Response
200 OK
{
"flavors":[
{
"name":"Small",
"links":[
{"href":"https://api.hostway.com/flavors/1/", "rel":"self"}
],
"vcpu":1,
"ram":512,
"disk":10,
"id":"1"
},
{
"name":"Large",
"links":[
{"href":"https://api.hostway.com/flavors/2/", "rel":"self"}
],
"vcpu":4,
"ram":16384,
"disk":60,
"id":"2"
}
]
}
Failure while trying to make an unauthorized request
Request
GET /flavors/detail
Authorization: Basic {invalid authorization}
Response
401 Unauthorized
See also
