From Hostway API Documentation

(Difference between revisions)

Jump to: navigation, search

Latest revision as of 11:00, 11 October 2013

{id}

This operation will return size details of a single flavor.

[edit] Request

GET /accounts/{accountId}/flexcloud/flavors/detail/{id}

[edit] Parameters

accountId - string: The selected account Id.

id: The unique identifier of the flavor to be retrieved. Note see warnings in Hypermedia.

[edit] Response

[edit] Status Code

200 OK
Success

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.

403 Forbidden
The resource cannot be accessed by the user

404 Not Found
The requested resource does not exist

[edit] Response Body

{
  "flavor":{
    "name":"{display_flavor_name}",
    "links":[
      {"href":"https://api.hostway.com/accounts/{accountId}/flexcloud/flavors/{flavor_id}/", "rel":"self"}
    ],
    "vcpu":"1",
    "ram":512,
    "disk":10,
    "id":"{flavor_id}"
  }
}

[edit] 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.

[edit] Examples

[edit] Successfully view flavor details

Request

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

Response

200 OK

{
  "flavor":{
    "name":"Small", 
    "links":[
      {"href":"https://api.hostway.com/accounts/{accountId}/flexcloud/flavors/1/", "rel":"self"}
    ], 
    "vcpu":"1", 
    "ram":512, 
    "disk":10, 
    "id":"1"
  }
}

[edit] Failure while trying to make an unauthorized request

Request

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

Response

401 Unauthorized

[edit] Failure while trying to access a flavor that is not allowed for this user

Request

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

Response

403 Forbidden

{
  "forbidden": {
    "message": "forbidden",
    "code": 403,
    "details": "",
    "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
  }
}

[edit] Failure while trying to access a flavor that does not exist

Request

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

Response

404 Not Found

{
  "itemNotFound": {
    "message": "Resource not found",
    "code": 404,
    "details": "",
    "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
  }
}

[edit] Account not found

Request

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

Response

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

[edit] Alternative URI /flavors/detail/{id}

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 /flavors/detail/{id}

[edit] See also

blog comments powered by Disqus

Flavor

Latest revision as of 11:00, 11 October 2013

[edit] GET /accounts/{accountId}/flexcloud/flavors/detail/{id}

Contents

[edit] Request

[edit] Parameters

[edit] Response

[edit] Status Code

[edit] Response Body

[edit] Parameters

[edit] Examples

[edit] Successfully view flavor details

[edit] Failure while trying to make an unauthorized request

[edit] Failure while trying to access a flavor that is not allowed for this user

[edit] Failure while trying to access a flavor that does not exist

[edit] Account not found

[edit] Alternative URI /flavors/detail/{id}

[edit] See also

Personal tools

Namespaces

Variants

Views

Actions

Search

APIs

Navigation

Toolbox

@@ Line 1: / Line 1: @@
+= GET /accounts/''{accountId}''/flexcloud/flavors/detail/''{id}'' =
 This operation will return size details of a single flavor.
+__TOC__
+== Request ==
+<code>GET /accounts/''{accountId}''/flexcloud/flavors/detail/''{id}''</code>
-'''GET''' /flavors/detail/'''id'''
+=== Parameters ===
+; accountId - ''string''
+: The selected account Id.
-== Parameters ==
 ; id
 : The unique identifier of the flavor to be retrieved. ''Note see warnings in [[Hypermedia]]''.
-== Result ==
+== Response ==
-=== JSON ===
+=== Status Code ===
+: 200 OK
+; Success
+: 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.
+: 403 Forbidden
+; The resource cannot be accessed by the user
+: 404 Not Found
+; The requested resource does not exist
+=== Response Body ===
   <nowiki>
- {
+{
-   "flavor":
+  "flavor":{
-      {
+    "name":"{display_flavor_name}",
-         "name":"{display_flavor_name}",
+    "links":[
-         "links":[
+      {"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/{flavor_id}/", "rel":"self"}
-            {
+    ],
-               "href":"http://{api_server}/flavors/{flavor_id}/",
+    "vcpu":"1",
-               "rel":"self"
+    "ram":512,
-            }
+    "disk":10,
-         ],
+    "id":"{flavor_id}"
-         "vcpu":"1",
+  }
-         "ram":512,
+}</nowiki>
-         "disk":10,
-         "id":"{flavor_id}"
-      }
-}
-</nowiki>
+==== Parameters ====
 ; id - ''string''
 : Unique identifier for this flavor.
@@ Line 45: / Line 60: @@
 ; vcpu - ''number''
 : Number of CPUs allocated with this flavor.
-== Response Codes ==
-:''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.
-:''HTTP/1.1 403 Forbidden'' - The resource cannot be accessed by the user
-:''HTTP/1.1 404 Not Found''' - The requested resource does not exist
 == Examples ==
-'''Successfully view flavor details'''
-:'''GET''' <nowiki>http://{api_server}/flavors/1</nowiki>
-''Request Headers:''
+=== Successfully view flavor details ===
-    Content-Type:application/json
+'''Request'''
-    Charset=UTF-8
+ <nowiki>
-    Authorization:Base64-encoded username & password string
+GET /accounts/{accountId}/flexcloud/flavors/1
+Authorization: Basic {Base64-encoded username:password string}</nowiki>
-''Response Code:''
-<pre>HTTP/1.1 200 OK</pre>
-''Response Body:''
+'''Response'''
   <nowiki>
-     {
+OK
-       "flavor":
-          {
-             "name":"Small",
-             "links":[
-                {
-                  "href":"http://{api_server}/flavors/1/",
-                  "rel":"self"
-                }
-             ],
-             "vcpu":"1",
-             "ram":512,
-             "disk":10,
-             "id":"1"
-           }
-      }
-</nowiki>
-'''Failure while trying to make an unauthorized request'''
+{
-:'''GET''' <nowiki>http://{api_server}/flavors/{flavor_id}</nowiki>
+  "flavor":{
+    "name":"Small",
+    "links":[
+      {"href":"</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/flexcloud/flavors/1/", "rel":"self"}
+    ],
+    "vcpu":"1",
+    "ram":512,
+    "disk":10,
+    "id":"1"
+  }
+}</nowiki>
-''Request Headers:''
+=== Failure while trying to make an unauthorized request ===
-    Content-Type:application/json
+'''Request'''
-    Charset=UTF-8
+ <nowiki>
-    Authorization:Base64-encoded <span style="color:red">fake_authentication_string</span>
+GET /accounts/{accountId}/flexcloud/flavors/1
+Authorization: Basic {invalid authorization}</nowiki>
-''Response Code:''
+'''Response'''
-<pre>HTTP/1.1 401 Unauthorized</pre>
+ <nowiki>
+Unauthorized</nowiki>
-''Response Body:''
+=== Failure while trying to access a flavor that is not allowed for this user ===
-Unauthorized
+'''Request'''
-     This server could not verify that you are authorized to
+  <nowiki>
-     access the document you requested.  Either you supplied the
+GET /accounts/{accountId}/flexcloud/flavors/101
-     wrong credentials (e.g., bad password), or your browser
+Authorization: Basic {Base64-encoded username:password string}</nowiki>
-     does not understand how to supply the credentials required.
+'''Response'''
+ <nowiki>
+Forbidden
-'''Failure while trying to access a flavor that is not allowed for this user'''
+{
-:'''GET''' <nowiki>http://{api_server}/flavors/{flavor_id}</nowiki>
+  "forbidden": {
+    "message": "forbidden",
+    "code": 403,
+    "details": "",
+    "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
+  }
+}</nowiki>
-''Request Headers:''
+=== Failure while trying to access a flavor that does not exist ===
-    Content-Type:application/json
+'''Request'''
-    Charset=UTF-8
+ <nowiki>
-    Authorization:Base64-encoded username & password string
+GET /accounts/{accountId}/flexcloud/flavors/missing_flavor_id
+Authorization: Basic {Base64-encoded username:password string} </nowiki>
-''Response Code:''
-<pre>HTTP/1.1 403 Forbidden</pre>
-''Response Body:''
+'''Response'''
   <nowiki>
-     {
+Not Found
-        "forbidden":
-        {
-            "message": "forbidden",
-            "code": 403,
-            "details": "",
-            "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
-        }
-     }</nowiki>
+{
+  "itemNotFound": {
+    "message": "Resource not found",
+    "code": 404,
+    "details": "",
+    "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
+  }
+} </nowiki>
-'''Failure while trying to access a flavor that does not exist'''
+=== Account not found ===
-:'''GET''' http(s)://{api_server}/flavors/{<span style="color:red">fake_flavor_id</span>}
+'''Request'''
+ <nowiki>
+GET /accounts/fake/flexcloud/flavors/101
+Authorization: Basic {Base64-encoded username:password string}</nowiki>
-''Request Headers:''
+'''Response'''
-     Content-Type:application/json
+ <nowiki>
-    Charset=UTF-8
+{
-    Authorization:Base64-encoded username & password string
+     "itemNotFound": {
+        "guid": "23684df5-0532-4794-802d-fdc82e4e7e7c",
+        "message": "Resource not found",
+        "code": 404,
+        "details": ""
+    }
+}</nowiki>
-''Response Code:''
+== Alternative URI /flavors/detail/{id} ==
-<pre>HTTP/1.1 404 Not Found</pre>
+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]].
-''Response Body:''
+<code>GET /flavors/detail/{id}</code>
- <nowiki>
-     {
+== See also ==
-         "itemNotFound":
+* [[FlexCloud Server|FlexCloud Server API]]
-         {
+* [[Common Features]]
-             "message": "Resource not found",
-             "code": 404,
-             "details": "",
-             "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
-         }
-     }</nowiki>
+{{disqus}}
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]