Latest revision as of 11:00, 11 October 2013

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

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

[edit] Parameters

accountId - string

The selected account Id.

id

The unique identifier of the server.

[edit] Result

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

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

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

[edit] 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"
    }
 }

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