ListVolumeAttachmentsForServer

From Hostway API Documentation
(Difference between revisions)
Jump to: navigation, search
m (1 revision: Release 86)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
=='''GET''' /servers/'''id'''/os-volume_attachments''==
 
 
This operation will list all of the volume attachments for a specific [[Server]].
 
This operation will list all of the volume attachments for a specific [[Server]].
  
−
=== Parameters ===
+
='''GET''' /accounts/''{accountId}''/flexcloud/servers/''{id}''/os-volume_attachments''=
 +
 
 +
== Parameters ==
 +
; accountId - ''string''
 +
: The selected account Id.
 +
 
 
; id
 
; id
 
: The unique identifier of the server.
 
: The unique identifier of the server.
  
−
=== Result ===
+
== Result ==
−
==== JSON ====
+
=== JSON ===
 
  <nowiki>
 
  <nowiki>
 
  {
 
  {
Line 26: Line 30:
 
  }</nowiki>
 
  }</nowiki>
  
−
=====volumeAttachments=====
+
====volumeAttachments====
 
; device - ''string''
 
; device - ''string''
 
: Device used for this volume attachment.
 
: Device used for this volume attachment.
Line 39: Line 43:
 
: Unique volume identifier.
 
: Unique volume identifier.
  
−
=== Response Codes ===
+
== Response Codes ==
 
; Success:
 
; Success:
 
:''HTTP/1.1 200 OK''
 
:''HTTP/1.1 200 OK''
Line 47: Line 51:
 
:''HTTP/1.1 404 Not Found''
 
:''HTTP/1.1 404 Not Found''
  
−
=== Examples ===
+
== Examples ==
 
'''Successfully list volume attachments'''
 
'''Successfully list volume attachments'''
−
:'''GET''' http(s)://{api_server}/servers/{server_id}/os-volume_attachments
+
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/os-volume_attachments
  
 
''Request Headers:''
 
''Request Headers:''
Line 79: Line 83:
  
 
'''Failure while trying to list volume attachments for a non-existent server'''
 
'''Failure while trying to list volume attachments for a non-existent server'''
−
:'''GET''' http(s)://{api_server}/servers/{<span style="color:red">fake_server_id</span>}/os-volume_attachments
+
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{<span style="color:red">fake_server_id</span>}/os-volume_attachments
  
  
Line 91: Line 95:
  
 
''Response Body:''
 
''Response Body:''
−
  {
+
  <nowiki>
 +
{
 
     "itemNotFound" : {
 
     "itemNotFound" : {
 
       "message": "Resource not found",  
 
       "message": "Resource not found",  
 
       "code": 404,  
 
       "code": 404,  
−
       "details": ""
+
       "details": "",
 +
      "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
 
     }
 
     }
−
  }
+
  }</nowiki>
  
 
'''Unauthorized request'''
 
'''Unauthorized request'''
−
:'''GET''' http(s)://{api_server}/servers/{server_id}/os-volume_attachments
+
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/os-volume_attachments
  
 
''Request Headers:''
 
''Request Headers:''
Line 117: Line 123:
 
     does not understand how to supply the credentials required.
 
     does not understand how to supply the credentials required.
  
−
[[Category:Hostway API]]
+
'''Failure while trying to pass invalid account number'''
−
[[Category:FlexCloud Server API]]
+
:'''GET''' http(s)://{api_server}/accounts/fake/flexcloud/servers/{id}/os-volume_attachments
  
−
<!--  THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->
+
''Response Code:''
 +
<pre>HTTP/1.1 404 Not Found</pre>
  
−
{{#widget:DISQUS
+
''Response Body:''
−
|id=hostway
+
<nowiki>
−
|uniqid={{PAGENAME}}
+
{
−
|url={{fullurl:{{PAGENAME}}}}
+
    "itemNotFound" : {
−
}}
+
      "message": "Resource not found",
 +
      "code": 404,
 +
      "details": "",
 +
      "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
 +
    }
 +
}</nowiki>
  
−
<!--  ########################################################################### -->
+
== Alternative URI /servers/{id}/os-volume_attachments ==
 +
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]].
 +
 
 +
<code>GET /servers/{id}/os-volume_attachments</code>
 +
 
 +
[[Category:Hostway API]]
 +
[[Category:FlexCloud Server API]]

Latest revision as of 12:00, 11 October 2013

This operation will list all of the volume attachments for a specific Server.

Contents

GET /accounts/{accountId}/flexcloud/servers/{id}/os-volume_attachments

Parameters

accountId - string
The selected account Id.
id
The unique identifier of the server.

Result

JSON 

 {
    "volumeAttachments": [
       {
          "device": "{device_path}",
          "serverId": {server_id},
          "id": {volume_attachment_id},
          "volumeId": {volume_id}
       },
       {
          "device": "{device_path}",
          "serverId": {server_id},
          "id": {volume_attachment_id},
          "volumeId": {volume_id}
       }
    ] 
 }

volumeAttachments

device - string
Device used for this volume attachment.
serverId - string
Unique server identifier.
id - string
Unique volume attachment identifier.
volumeId - string
Unique volume identifier.

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 incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
HTTP/1.1 404 Not Found

Examples

Successfully list volume attachments

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/os-volume_attachments

Request Headers: 

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code: 

HTTP/1.1 200 OK

Response Body: 

 {
    "volumeAttachments": [
       {
          "device": "/dev/test",
          "serverId": 6,
          "id": 1,
          "volumeId": 41
       },
       {
          "device": "/dev/test1",
          "serverId": 6,
          "id": 2,
          "volumeId": 23
       }
    ] 
 }

Failure while trying to list volume attachments for a non-existent server

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{fake_server_id}/os-volume_attachments


Request Headers: 

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code: 

HTTP/1.1 404 Not Found

Response Body: 

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

Unauthorized request

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/os-volume_attachments

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.

Failure while trying to pass invalid account number

GET http(s)://{api_server}/accounts/fake/flexcloud/servers/{id}/os-volume_attachments

Response Code: 

HTTP/1.1 404 Not Found

Response Body: 

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

Alternative URI /servers/{id}/os-volume_attachments

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 /servers/{id}/os-volume_attachments

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