Create Volume - Revision history

Mike.robski: 1 revision: Release 86

2013-10-11T17:00:57Z

1 revision: Release 86

Emanuela.mitreva at 15:52, 11 July 2013

2013-07-11T15:52:05Z

Mike.robski: 1 revision

2013-05-24T15:25:00Z

1 revision

Mike.robski at 13:19, 20 May 2013

2013-05-20T13:19:09Z

Mike.robski at 21:00, 14 December 2012

2012-12-14T21:00:27Z

Mike.robski at 20:38, 14 December 2012

2012-12-14T20:38:04Z

Administrator: Created page with "A Volume provides storage space that can be used with your Server. This storage space is independent from the storage space that is included with your Server. Once a volume is..."

2012-07-04T21:26:26Z

Created page with "A Volume provides storage space that can be used with your Server. This storage space is independent from the storage space that is included with your Server. Once a volume is..."

New page

A Volume provides storage space that can be used with your Server. This storage space is independent from the storage space that is included with your Server. Once a volume is created, it can be easily attached to a Server. Once attached, it will appear as a mounted device. You can attach multiple volumes to a Server.

='''POST''' /volumes=
This operation will create a new volume.

== Request ==
=== JSON ===
<nowiki>
{
"volume" : {
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : {size_quantity},
"volume_type" : "{volume_type_id}",
"metadata" : {
"contents": "{contents_type}"
},
"availability_zone" : "{availability_zone_id}"
}
}
</nowiki>

====volume====
; display_name - ''string''
: Display name for this volume.

; display_description - ''string''
: Descriptive information for this volume.

; size - ''int''
: Volume size.

; volume_type - ''string''
: Identifier of volume type. *(Unused in the current API version - please pass empty value).

; metadata - ''string''
: Additional metadata info.

; availability_zone - ''string''
: Identifier of the availability zone into which this volume is created.

== Response ==
=== JSON ===
<nowiki>
{
"volume": {
"status": "{volume_status}"
"id": "{volume_id}",
"display_name" : "{display_volume_name}",
"display_description" : "{display_volume_description}",
"size" : {size_quantity},
"volume_type" : "{volume_type_id}",
"metadata" : {
"contents": "{contents_type}"
},
"availability_zone" : "{availability_zone_id}"
"snapshot_id": "",
"attachments": [],
"created_at": "2012-02-14T20:53:07Z"
}
}
</nowiki>

====volume====
; status - ''string''
: Current status of the volume instance. Possible values: '''Pending''', '''Open''' and '''ClosePending'''.

; id - ''string''
: Identifier of the volume instance.

; display_name - ''string''
: Display name for this volume.

; display_description - ''string''
: Descriptive information for this volume.

; size - ''int''
: Volume size.

; volume_type - ''string''
: Identifier of the volume type used. *(Unused in the current API version - please pass empty value).

; metadata - ''string''
: Additional metadata info.

; availability_zone - ''string''
: Identifier of the availability zone into which this volume is created.

; snapshot_id - ''string''
: Identifier of the snapshot associated with this volume.

; attachments - ''list''
: List of attachments this volume is associated with.

; created_at - ''string''
: Volume creation timestamp.

== Response Codes ==
; Success
: ''HTTP/1.1 200 OK''

; Failure
: ''HTTP/1.1 400 Bad Request''
: ''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 409 Conflict''

== Examples ==
'''Successfully create a new volume'''
:'''POST''' http(s)://{api_server}/volumes

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

''Request Body:''
<nowiki>
{
"volume" : {
"display_name" : "test_volume_001",
"display_description" : "Test_Volume_001_Description.",
"size" : 30,
"volume_type" : "289da7f8-6440-407c-9fb4-7db01ec49164",
"metadata" : {
"contents": "junk"
},
"availability_zone" : "test_zone"
}
}
</nowiki>

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
{
"volume": {
"status": "Pending",
"id": 8,
"display_name" : "test_volume_001",
"display_description" : "Test_Volume_001_Description.",
"size" : 30,
"availability_zone" : "test_zone"
"attachments": [],
"created_at": "2012-05-07 15:15:21.678868"
}
}
</nowiki>

'''Failure while trying to create a new volume with an already existing volume name'''
:'''POST''' http(s)://{api_server}/volumes

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

''Request Body:''
{
"volume" : {
"display_name" : "test_volume_001",
"display_description" : "Test creating a new volume with already existing volume name.",
"size" : 30,
"volume_type" : "289da7f8-6440-407c-9fb4-7db01ec49164",
"metadata" : {"contents": "junk"},
"availability_zone" : "test_zone"
}
}

''Response Code:''
<pre>HTTP/1.1 409 Conflict</pre>

''Response Body:''
<nowiki>
{
"conflict": {
"message": "VolumeNameAlreadyExists",
"code": 409,
"details": "hbs name already exists"
}
}</nowiki>

'''Failure while trying to create a new volume with a volume name that is too long'''
:'''POST''' http(s)://{api_server}/volumes

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

''Request Body:''
{
"volume" : {
"display_name" : "vol-test-name-tooooooooooooooooooooooooooooooooooooooooooolong",
"display_description" : "Test creating a volume with too long volume name.",
"size" : 30,
"volume_type" : "289da7f8-6440-407c-9fb4-7db01ec49164",
"metadata" : {"contents": "junk"},
"availability_zone" : "test_zone"
}
}

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "DisplayNameTooLong",
"code": 400,
"details": "String length exceeded. check your arguments"
}
}</nowiki>

'''Failure while trying to create a new volume with an invalid availability zone(empty zone)'''
:'''POST''' http(s)://{api_server}/volumes

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

''Request Body:''
{
"volume" : {
"display_name" : "vol-test-name-invalid-zone",
"display_description" : "Test creating a volume with invalid availability zone(empty zone).",
"size" : 10,
"volume_type" : "289da7f8-6440-407c-9fb4-7db01ec49164",
"metadata" : {"contents": "junk"},
"availability_zone" : ""
}
}

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "Invalid",
"code": 400,
"details": ""
}
}</nowiki>

'''Failure while trying to create a new volume with an invalid volume size'''
:'''POST''' http(s)://{api_server}/volumes

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

''Request Body:''
{
"volume" : {
"display_name" : "vol-test-name-invalid-zone",
"display_description" : "Test creating a volume with invalid availability zone(empty zone).",
"size" : 500,
"volume_type" : "289da7f8-6440-407c-9fb4-7db01ec49164",
"metadata" : {"contents": "junk"},
"availability_zone" : "test_zone"
}
}

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "VolumeSize",
"code": 400,
"details": "not available HBS Size"
}
}</nowiki>

'''Unauthorized access'''
:'''POST''' http(s)://{api_server}/volumes

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''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.



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

← Older revision		Revision as of 20:38, 14 December 2012
Line 299:		Line 299:
	does not understand how to supply the credentials required.		does not understand how to supply the credentials required.

		+
		+	[[Category: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-->

@@ Line 1: / Line 1: @@
 A Volume provides storage space that can be used with your Server. This storage space is independent from the storage space that is included with your Server. Once a volume is created, it can be easily attached to a Server. Once attached, it will appear as a mounted device. You can attach multiple volumes to a Server.
-='''POST''' /volumes=
+='''POST''' /accounts/''{accountId}''/flexcloud/volumes=
 This operation will create a new volume.
 == Request ==
 === JSON ===
   <nowiki>
@@ Line 18: / Line 23: @@
          "availability_zone" : "{availability_zone_id}"
+    }
 }</nowiki>
 </nowiki>
 ====volume====
@@ Line 59: / Line 63: @@
         "created_at": "2012-02-14T20:53:07Z"
+    }
 }</nowiki>
 </nowiki>
 ====volume====
@@ Line 103: / Line 106: @@
 : ''HTTP/1.1 400 Bad Request''
 : ''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 409 Conflict''
 == Examples ==
 '''Successfully create a new volume'''
-:'''POST''' http(s)://{api_server}/volumes
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes
 ''Request Headers:''
@@ Line 127: / Line 131: @@
          "availability_zone" : "test_zone"
+    }
   } </nowiki>
- </nowiki>
 ''Response Code:''
@@ Line 146: / Line 149: @@
          "created_at": "2012-05-07 15:15:21.678868"
+     }
 }</nowiki>
 </nowiki>
 '''Failure while trying to create a new volume with an already existing volume name'''
-:'''POST''' http(s)://{api_server}/volumes
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes
 ''Request Headers:''
@@ Line 158: / Line 160: @@
 ''Request Body:''
+  {
      "volume" : {
@@ Line 167: / Line 170: @@
          "availability_zone" : "test_zone"
+    }
+  }</nowiki>
 ''Response Code:''
@@ Line 184: / Line 187: @@
 '''Failure while trying to create a new volume with a volume name that is too long'''
-:'''POST''' http(s)://{api_server}/volumes
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes
 ''Request Headers:''
@@ Line 192: / Line 195: @@
 ''Request Body:''
+  {
      "volume" : {
@@ Line 201: / Line 205: @@
          "availability_zone" : "test_zone"
+    }
+  }</nowiki>
 ''Response Code:''
@@ Line 218: / Line 222: @@
 '''Failure while trying to create a new volume with an invalid availability zone(empty zone)'''
-:'''POST''' http(s)://{api_server}/volumes
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes
 ''Request Headers:''
@@ Line 226: / Line 230: @@
 ''Request Body:''
+  {
      "volume" : {
@@ Line 235: / Line 240: @@
          "availability_zone" : <span style="color:red">""</span>
+    }
+  }</nowiki>
 ''Response Code:''
@@ Line 252: / Line 257: @@
 '''Failure while trying to create a new volume with an invalid volume size'''
-:'''POST''' http(s)://{api_server}/volumes
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes
 ''Request Headers:''
@@ Line 260: / Line 265: @@
 ''Request Body:''
+  {
      "volume" : {
@@ Line 269: / Line 275: @@
          "availability_zone" : "test_zone"
+    }
+  }</nowiki>
 ''Response Code:''
@@ Line 286: / Line 292: @@
 '''Unauthorized access'''
-:'''POST''' http(s)://{api_server}/volumes
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/volumes
 ''Request Headers:''
@@ Line 302: / Line 308: @@
       wrong credentials (e.g., bad password), or your browser
       does not understand how to supply the credentials required.
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]

@@ Line 1: / Line 1: @@
 A Volume provides storage space that can be used with your Server. This storage space is independent from the storage space that is included with your Server. Once a volume is created, it can be easily attached to a Server. Once attached, it will appear as a mounted device. You can attach multiple volumes to a Server.
-=='''POST''' /volumes==
+='''POST''' /volumes=
 This operation will create a new volume.
-=== Request ===
+== Request ==
-==== JSON ====
+=== JSON ===
   <nowiki>
+{
@@ Line 21: / Line 21: @@
 </nowiki>
-=====volume=====
+====volume====
 ; display_name - ''string''
 : Display name for this volume.
@@ Line 40: / Line 40: @@
 : Identifier of the availability zone into which this volume is created.
-=== Response ===
+== Response ==
-==== JSON ====
+=== JSON ===
   <nowiki>
+{
@@ Line 62: / Line 62: @@
 </nowiki>
-=====volume=====
+====volume====
 ; status - ''string''
 : Current status of the volume instance. Possible values: '''Pending''', '''Open''' and '''ClosePending'''.
@@ Line 96: / Line 96: @@
 : Volume creation timestamp.
-=== Response Codes ===
+== Response Codes ==
 ; Success
 : ''HTTP/1.1 200 OK''
@@ Line 105: / Line 105: @@
 : ''HTTP/1.1 409 Conflict''
-=== Examples ===
+== Examples ==
 '''Successfully create a new volume'''
 :'''POST''' http(s)://{api_server}/volumes
@@ Line 178: / Line 178: @@
        "message": "VolumeNameAlreadyExists",
        "code": 409,
-       "details": "hbs name already exists"
+       "details": "hbs name already exists",
+    }
   }</nowiki>
@@ Line 211: / Line 212: @@
         "message": "DisplayNameTooLong",
         "code": 400,
-        "details": "String length exceeded. check your arguments"
+        "details": "String length exceeded. check your arguments",
+     }
   }</nowiki>
@@ Line 244: / Line 246: @@
         "message": "Invalid",
         "code": 400,
-        "details": ""
+        "details": "",
+     }
   }</nowiki>
@@ Line 277: / Line 280: @@
         "message": "VolumeSize",
         "code": 400,
-        "details": "not available HBS Size"
+        "details": "not available HBS Size",
+     }
   }</nowiki>
@@ Line 298: / Line 302: @@
       wrong credentials (e.g., bad password), or your browser
       does not understand how to supply the credentials required.
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]