Last updated August 20, 2009 23:18, by Tim Bray
<h1>Cloud API Specification - Requests to Volume Resources</h1>
The requests documented in this section are directed to ''Volume'' resources, which represent WebDAV volumes on the storage service.
__TOC__
= Get Volume =
Retrieve information about a Volume.
'''Synopsis:''' GET {URI of Volume from owning VDC }
'''Request Headers:''' Accept, Authorization, X-Cloud-Client-Specification-Version.
'''Request Message Body:''' N/A.
'''Response Headers:''' Content-Length, Content-Type.
'''Response Message Body:''' Volume.
'''Response Status:''' 200, 400, 401, 403, 404.
'''Example Request:''' Retrieve information about a Volume named "backups".
GET /volumes/1234567890
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Accept: application/vnd.com.sun.cloud.Volume+json
X-Cloud-Client-Specification-Version: 0.1
'''Example Response:'''
HTTP/1.1 200 OK
Content-Type: application/vnd.com.sun.cloud.Volume+json
Content-Length: nnn
{
"name" : "backups",
"uri" : "http://example.com/volumes/1234567890",
"webdav" : "https://storage.cloud.sun.com/uc999999/backups"
}
= Update Volume Properties =
Update the specified properties of a Volume. Only fields actually included in the request message body will be updated, and existing contents of those fields will be completely replaced.
'''Synopsis:''' PUT { URI of Volume }
'''Request Headers:''' Accept, Authorization, Content-Length, Content-Type, X-Cloud-Client-Specification-Version.
'''Request Parameters:''' N/A.
'''Request Message Body:''' Volume.
'''Response Headers:''' Content-Length, Content-Type.
'''Response Message Body:''' Status for use in tracking update progress.
'''Response Status:''' 202, 400, 401, 403, 404.
'''Status "op" Value:''' "update-Volume".
'''Status "target_uri" identifies:''' The Volume receiving the PUT.
'''Example Request:''' Add a "needs_snapshot" tag to this volume.
PUT /volumes/1234567890
Host: example.com
Authorization: Basic xxxxxxxxxxxxxx
Accept: application/vnd.com.sun.cloud.Volume+json
Content-Length: nnn
Content-Type: application/vnd.com.sun.cloud.Volume+json
X-Cloud-Client-Specification-Version: 0.1
{
"tags" : [ "default", "needs_snapshot" ]
}
'''Example Response:'''
HTTP/1.1 202 Accepted
Content-Type: application/vnd.com.sun.cloud.Status+json
Content-Length: nnn
{
"op": "update-Volume",
"progress": 0,
"target_uri": "/volumes/1234567890",
"status_uri": "/statuses?op=update-volume&seq=73917192",
}
= Delete Volume =
Delete the specified WebDAV volume from the storage service.
'''Synopsis:''' DELETE { URI of Volume }
'''Request Headers:''' Authorization, X-Cloud-Client-Specification-Version.
'''Request Parameters:''' N/A.
'''Request Message Body:''' N/A.
'''Response Headers:''' Content-Length, Content-Type.
'''Response Message Body:''' Status for use in tracking deletion progress.
'''Response Status:''' 202, 400, 401, 403, 404.
'''Status "op" Value:''' "delete-Volume".
'''Status "target_uri" identifies:''' The Volume being deleted.
'''Example Request:''' Delete an existing Volume named "backups"
DELETE /volumes/1234567890
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
X-Cloud-Client-Specification-Version: 0.1
'''Example Response:'''
HTTP/1.1 202 Accepted
Content-Type: application/vnd.com.sun.cloud.Status+json
Content-Length: nnn
{
"op": "delete-Volume",
"progress": 0,
"target_uri": "/volumes/1234567890",
"status_uri": "/statuses?op=delete-volume&cluster=1234567890",
}
Copyright © Sun Microsystems, 2009. This work is licensed under [http://creativecommons.org/licenses/by/3.0/ Creative Commons Attribution 3.0 Unported License]





