FlavorList
(Difference between revisions)
Mike.robski (Talk | contribs) |
Mike.robski (Talk | contribs) |
||
| Line 1: | Line 1: | ||
This operation will list all available flavors optionally limited by the query parameters. | This operation will list all available flavors optionally limited by the query parameters. | ||
| − | '''GET''' /flavors?''minDisk=diskInGB&minRam=ramInMB'' | + | =='''GET''' /flavors?''minDisk=diskInGB&minRam=ramInMB''== |
| − | == Parameters == | + | === Parameters === |
; minDisk - ''int'' | ; minDisk - ''int'' | ||
: ''Optional'' Only flavors with a disk size greater than or equal to minDisk will be returned. Specified in GB. | : ''Optional'' Only flavors with a disk size greater than or equal to minDisk will be returned. Specified in GB. | ||
| Line 12: | Line 12: | ||
''Also see [[Pagination]]'' | ''Also see [[Pagination]]'' | ||
| − | == Result == | + | === Result === |
| − | === JSON === | + | ==== JSON ==== |
<nowiki> | <nowiki> | ||
{ | { | ||
| Line 50: | Line 50: | ||
: Display name for this flavor. | : Display name for this flavor. | ||
| − | == Response Codes == | + | === Response Codes === |
; Success: HTTP/1.1 200 OK | ; 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. | ; 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 == | + | === Examples === |
'''Successfully list available flavors''' | '''Successfully list available flavors''' | ||
| Line 121: | Line 121: | ||
does not understand how to supply the credentials required. | does not understand how to supply the credentials required. | ||
| − | [[Category:API]] | + | [[Category:Hostway API]] |
| + | [[Category:FlexCloud Server API]] | ||
<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING--> | <!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING--> | ||
Revision as of 16:01, 14 December 2012
This operation will list all available flavors optionally limited by the query parameters.
Contents |
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.
