FlavorList

From Hostway API Documentation
(Difference between revisions)
Jump to: navigation, search
m (1 revision: Release 86)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
This operation will list all available flavors optionally limited by the query parameters.
+
= GET /accounts/''{accountId}''/flexcloud/flavors?minDisk=''{diskInGB}''&minRam=''{ramInMB}'' =
 +
Lists all available flavors optionally limited by the query parameters.
 +
__TOC__
 +
== Request ==
 +
<code>GET /accounts/''{accountId}''/flexcloud/flavors?minDisk=''{diskInGB}''&minRam=''{ramInMB}''</code>
  
−
'''GET''' /flavors?''minDisk=diskInGB&minRam=ramInMB''
+
=== URI Parameters ===
 +
; accountId - ''string''
 +
: The selected account Id.
  
−
== 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 17:
 
''Also see [[Pagination]]''
 
''Also see [[Pagination]]''
  
−
== Result ==
+
== Response ==
−
=== JSON ===
+
 
−
<big>
+
=== Status Code ===
−
<source lang="javascript">
+
; 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.
 +
 
 +
; 404 Not Found
 +
: Failure - Resource does not exists
 +
 
 +
=== Response Body ===
 +
<nowiki>
 
{
 
{
−
  "flavors":[
+
  "flavors":[
−
      {
+
    {
−
        "id":"{flavor_id}",
+
      "id":"{flavor_id}",
−
        "links":[
+
      "links":[
−
            {
+
        {"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/{flavor_id}/", "rel":"self"}
−
              "href":"http://{server_name}/flavors/{flavor_id}/",
+
      ],
−
              "rel":"self"
+
      "name":"{display_flavor_name}"
−
            }
+
    },
−
        ],
+
    {
−
        "name":"{display_flavor_name}"
+
      "id":"{flavor_id}",
−
      },
+
      "links":[
−
      {
+
        {"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/{flavor_id}/", "rel":"self"}
−
        "id":"{flavor_id}",
+
      ],
−
        "links":[
+
      "name":"{display_flavor_name}"
−
            {
+
    }
−
              "href":"http://{server_name}/flavors/{flavor_id}/",
+
  ]
−
              "rel":"self"
+
}</nowiki>
−
            }
+
−
        ],
+
−
        "name":"{display_flavor_name}"
+
−
      }
+
−
  ]
+
−
}
+
−
</source></big>
+
  
 +
==== Parameters ====
 
; id - ''string''
 
; id - ''string''
 
: Unique identifier for this flavor.
 
: Unique identifier for this flavor.
Line 50: Line 59:
 
; name - ''string''
 
; name - ''string''
 
: Display name for this flavor.
 
: 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 ==
 
== Examples ==
  
−
'''Successfully list available flavors'''
+
=== Successfully list available flavors ===
−
:'''GET''' <nowiki>http://{api_url}/flavors</nowiki>
+
'''Request'''
 +
<nowiki>
 +
GET /accounts/{accountId}/flexcloud/flavors
 +
Authorization: Basic {Base64-encoded username:password string}</nowiki>
  
−
''Request Headers:''
+
'''Response'''
−
    Content-Type:application/json
+
<nowiki>
−
    Charset=UTF-8
+
200 OK
−
    Authorization:Base64-encoded username & password string
+
  
−
''Response Code:''
+
{
−
<pre>HTTP/1.1 200 OK</pre>
+
  "flavors": [
−
 
+
    {
−
''Response Body:''
+
      "name": "Small",  
−
<big>
+
      "links": [
−
<source lang="javascript">
+
        {"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/1/", "rel": "self"},  
−
 
+
        {"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/1/", "rel": "bookmark"}
−
    {
+
      ],  
−
      "flavors": [
+
      "id": "1"
−
          {
+
    },
−
            "name": "Small",  
+
    {
−
            "links": [
+
      "name": "Large",  
−
              {
+
      "links": [
−
                "href": "http://{server_name}/flavors/1/",  
+
        {"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/3/", "rel": "self"},
−
                "rel": "self"
+
        {"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/3/", "rel": "bookmark"}
−
              },  
+
      ],
−
              {
+
      "id": "3"
−
                "href": "http://{server_name}/flavors/1/",  
+
−
                "rel": "bookmark"
+
−
              }
+
−
            ],  
+
−
            "id": "1"
+
−
          },
+
−
          {
+
−
            "name": "Large",  
+
−
            "links": [
+
−
              {
+
−
                  "href": "<nowiki>http://{server_name}/flavors/3/</nowiki>",  
+
−
                  "rel": "self"
+
−
              },  
+
−
              {
+
−
                  "href": "<nowiki>http://{server_name}/flavors/3/",  
+
−
                  "rel": "bookmark"}
+
−
            ],
+
−
            "id": "3"
+
−
          }
+
−
      ]
+
 
     }
 
     }
−
</source></big>
+
  ]
 +
}</nowiki>
  
−
'''Unauthorized request'''
+
=== Failure while trying to make an unauthorized request ===
−
:'''GET''' <nowiki>http://{api_url}/flavors</nowiki>
+
'''Request'''
 +
<nowiki>
 +
GET /accounts/{accountId}/flexcloud/flavors
 +
Authorization: Basic {invalid authorization}</nowiki>
  
−
''Request Headers:''
+
'''Response'''
−
    Content-Type:application/json
+
<nowiki>
 +
401 Unauthorized</nowiki>
  
−
''Response Code:''
+
=== Account not found ===
−
<pre>HTTP/1.1 401 Unauthorized</pre>
+
'''Request'''
 +
<nowiki>
 +
GET /accounts/fake/flexcloud/flavors
 +
Authorization: Basic {Base64-encoded username:password string}</nowiki>
 +
 
 +
'''Response'''
 +
<nowiki>
 +
{
 +
    "itemNotFound": {
 +
        "guid": "23684df5-0532-4794-802d-fdc82e4e7e7c",
 +
        "message": "Resource not found",
 +
        "code": 404,
 +
        "details": ""
 +
    }
 +
}</nowiki>
  
−
''Response Body:''
+
== See also ==
−
    401 Unauthorized
+
* [[FlexCloud Server|FlexCloud Server API]]
−
    This server could not verify that you are authorized to
+
* [[Common Features]]
−
    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.
+
  
−
<!--  THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->
+
== Alternative URI /flavors ==
 +
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].
  
−
{{#widget:DISQUS
+
<code>GET /accounts/{accountId}/flexcloud/flavors</code>
−
|id=hostway
+
−
|uniqid={{PAGENAME}}
+
−
|url={{fullurl:{{PAGENAME}}}}
+
−
}}
+
  
−
<!--  ########################################################################### -->
+
{{disqus}}
 +
[[Category:Hostway API]]
 +
[[Category:FlexCloud Server API]]

Latest revision as of 12:00, 11 October 2013

[edit] GET /accounts/{accountId}/flexcloud/flavors?minDisk={diskInGB}&minRam={ramInMB}

Lists all available flavors optionally limited by the query parameters.

Contents

[edit] Request

GET /accounts/{accountId}/flexcloud/flavors?minDisk={diskInGB}&minRam={ramInMB}

[edit] URI Parameters

accountId - string
The selected account Id.
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

[edit] Response

[edit] 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.
404 Not Found
Failure - Resource does not exists

[edit] Response Body 

{
  "flavors":[
    {
      "id":"{flavor_id}",
      "links":[
        {"href":"https://api.hostway.com/accounts/{accountId}/flexcloud/flavors/{flavor_id}/", "rel":"self"}
      ],
      "name":"{display_flavor_name}"
    },
    {
      "id":"{flavor_id}",
      "links":[
        {"href":"https://api.hostway.com/accounts/{accountId}/flexcloud/flavors/{flavor_id}/", "rel":"self"}
      ],
      "name":"{display_flavor_name}"
    }
  ]
}

[edit] Parameters

id - string
Unique identifier for this flavor.
links - array
Hypermedia for this resource.
name - string
Display name for this flavor.

[edit] Examples

[edit] Successfully list available flavors

Request 

GET /accounts/{accountId}/flexcloud/flavors
Authorization: Basic {Base64-encoded username:password string}

Response 

200 OK

{
  "flavors": [
    {
      "name": "Small", 
      "links": [
        {"href": "https://api.hostway.com/accounts/{accountId}/flexcloud/flavors/1/", "rel": "self"}, 
        {"href": "https://api.hostway.com/accounts/{accountId}/flexcloud/flavors/1/", "rel": "bookmark"}
      ], 
      "id": "1"
    },
    {
      "name": "Large", 
      "links": [
        {"href": "https://api.hostway.com/accounts/{accountId}/flexcloud/flavors/3/", "rel": "self"},
        {"href": "https://api.hostway.com/accounts/{accountId}/flexcloud/flavors/3/", "rel": "bookmark"}
      ],
      "id": "3"
    }
  ]
}

[edit] Failure while trying to make an unauthorized request

Request 

GET /accounts/{accountId}/flexcloud/flavors
Authorization: Basic {invalid authorization}

Response 

401 Unauthorized

[edit] Account not found

Request 

GET /accounts/fake/flexcloud/flavors
Authorization: Basic {Base64-encoded username:password string}

Response 

{
    "itemNotFound": {
        "guid": "23684df5-0532-4794-802d-fdc82e4e7e7c",
        "message": "Resource not found",
        "code": 404,
        "details": ""
    }
}

[edit] See also

[edit] Alternative URI /flavors

An alternative way to execute this call is to omit the accountId portion of the URI. In this case the system assumes the request is executed for the account identified in the authorization header.

GET /accounts/{accountId}/flexcloud/flavors


blog comments powered by Disqus

Retrieved from "http://docs.hostway.com/index.php?title=FlavorList&oldid=844"
Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox