2009-03-11T05:40:41Z

Rolled in async/status 1049 CloudAPIVDCRequests 7

139

<h1>Cloud API Specification - Requests to VDC Resources</h1> The requests documented in this section are directed to ''VDC'' resources, which represent an entire Virtual Data Center. The ''VDC URI'' used to retrieve a given VDC representation will be defined by the service implementor, not by this API specification. From there on, the URIs for all resources related to this VDC can be discovered (directly or indirectly) from the VDC representation itself. A VDC resource is read only from the perspective of this API, although its server side content is modified as a side effect of many other API requests. You should plan on performing the Get VDC request periodically to update your client's view of the VDC resource model. __TOC__ = Get VDC = Retrieve information about a cloud service VDC. '''Synopsis:''' GET {VDC URI} '''Request Headers:''' Accept, Authorization, X-Cloud-Client-Specification-Version. '''Request Parameters:''' N/A. '''Request Message Body:''' N/A. '''Response Headers:''' Content-Length, Content-Type. '''Response Message Body:''' VDC. '''Response Status:''' 200, 400, 401, 403. '''Example Request:''' Retrieve information about a VDC. GET / Host: example.com Authorization: Basic xxxxxxxxxxxxxxxxxxx Accept: application/vnd.com.sun.cloud.VDC+json X-Cloud-Client-Specification-Version: 0.1 '''Example Response:''' HTTP/1.1 200 OK Content-Type: application/vnd.com.sun.cloud.VDC+json Content-Length: nnn { "name" : "Example VDC", "uri" : "http://example.com/vdc/123456", "addresses" : [ ... ], "cluster" : { ... }, "tags" : [ ... ], "volumes": [ ... ], "vm_templates" : "http://example.com/templates/catalog" } = Create Public Address = Request the Allocation of a new Public Address for use in this VDC. Most of the fields of a Public Address resource are automatically set in the course of its use; the only field specified at creation time is its logical name. The request is a POST to the URI of the VDC; the Content-Type '''MUST''' be "application/vnd.com.sun.cloud.PublicAddress+json" '''Synopsis:''' POST { URI of VDC } '''Request Headers:''' Accept, Authorization, Content-Length, Content-Type, X-Cloud-Client-Specification-Version. '''Request Parameters:''' N/A. '''Request Message Body:''' Public Address. '''Response Headers:''' Content-Length, Content-Type. '''Response Message Body:''' Status for use in tracking Address allocaiton process. '''Response Status:''' 202, 400, 401, 403, 404. '''Status "op" Value:''' "new-Address". '''Status "target_uri" identifies:''' The new Public Address once it is allocated. '''Example 1 Request:''' Create a new Public Address named ''Load Balanced''. POST /vdcs/vdc001 Host: example.com Authorization: Basic xxxxxxxxxxxxxxxxxxx Accept: application/vnd.com.sun.cloud.PublicAddress+json Content-Length: nnn Content-Type: application/vnd.com.sun.cloud.PublicAddress+json X-Cloud-Specification-Version: 0.1 { "name" : "Load Balanced" } '''Example 1 Response:''' HTTP/1.1 202 Accepted Content-Type: application/vnd.com.sun.cloud.Status+json Content-Length: nnn { "op": "new-Address", "progress": 100, "target_uri": "/addresses/107.236.66.83", "status_uri": "/statuses?op=na&r=0389.aa6", "status": 201 } = Create Volume = Request the creation of a WebDAV volume on the storage service for the owner of this VDC. Most of the fields of a Volume resource are automatically set in the course of its use; the only field required at creation time is its logical name. The request is a POST to the URI of the VDC; the Content-Type '''MUST''' be "application/vnd.com.sun.cloud.Volume+json" '''Synopsis:''' POST { URI of VDC } '''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 volume-creation progress. '''Response Status:''' 202, 400, 401, 403, 404. '''Status "op" Value:''' "new-Volume". '''Status "target_uri" identifies:''' The new Volume once it is created. '''Example Request:''' Create a new Volume named ''backups''. POST /vdcs/vdc001 Host: example.com Authorization: Basic xxxxxxxxxxxxxxxxxxx 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 { "name" : "backups", "tags" : [ "default" ] } '''Example Response:''' HTTP/1.1 202 Accepted Content-Type: application/vnd.com.sun.cloud.Status+json Content-Length: nnn { "op": "new-Volume", "progress": 0, "target_uri": "/volumes/1234567890", "status_uri": "/statuses?op=nv&name=backups" } Copyright © Sun Microsystems, 2009. This work is licensed under [http://creativecommons.org/licenses/by/3.0/ Creative Commons Attribution 3.0 Unported License]

<h1>Cloud API Specification - Requests to VDC Resources</h1> The requests documented in this section are directed to VDC resources, which represent an entire Virtual Data Center. The VDC URI used to retrieve a given VDC representation will be defined by the service implementor, not by this API specification. From there on, the URIs for all resources related to this VDC can be discovered (directly or indirectly) from the VDC representation itself. A VDC resource is read only from the perspective of this API, although its server side content is modified as a side effect of many other API requests. You should plan on performing the Get VDC request periodically to update your client's view of the VDC resource model. <div id='toc' class='toc'> <div id='toctitle' class='toc-title'> Contents </div> <div id='toccontents' class='toc-contents'><ul><li>1 <a href='#Get_VDC'> Get VDC </a></li> <li>2 <a href='#Create_Public_Address'> Create Public Address </a></li> <li>3 <a href='#Create_Volume'> Create Volume </a></li> </ul></div> </div> <h1><a name='Get_VDC'></a> Get VDC </h1> Retrieve information about a cloud service VDC. Synopsis: GET {VDC URI} Request Headers: Accept, Authorization, X-Cloud-Client-Specification-Version. Request Parameters: N/A. Request Message Body: N/A. Response Headers: Content-Length, Content-Type. Response Message Body: VDC. Response Status: 200, 400, 401, 403. Example Request: Retrieve information about a VDC. <pre> GET / Host: example.com Authorization: Basic xxxxxxxxxxxxxxxxxxx Accept: application/vnd.com.sun.cloud.VDC+json X-Cloud-Client-Specification-Version: 0.1 </pre>Example Response: <pre> HTTP/1.1 200 OK Content-Type: application/vnd.com.sun.cloud.VDC+json Content-Length: nnn { "name" : "Example VDC", "uri" : "<a class='external' href="http://example.com/vdc/123456">http://example.com/vdc/123456</a>", "addresses" : [ ... ], "cluster" : { ... }, "tags" : [ ... ], "volumes": [ ... ], "vm_templates" : "<a class='external' href="http://example.com/templates/catalog">http://example.com/templates/catalog</a>" } </pre><h1><a name='Create_Public_Address'></a> Create Public Address </h1> Request the Allocation of a new Public Address for use in this VDC. Most of the fields of a Public Address resource are automatically set in the course of its use; the only field specified at creation time is its logical name. The request is a POST to the URI of the VDC; the Content-Type MUST be "application/vnd.com.sun.cloud.PublicAddress+json" Synopsis: POST { URI of VDC } Request Headers: Accept, Authorization, Content-Length, Content-Type, X-Cloud-Client-Specification-Version. Request Parameters: N/A. Request Message Body: Public Address. Response Headers: Content-Length, Content-Type. Response Message Body: Status for use in tracking Address allocaiton process. Response Status: 202, 400, 401, 403, 404. Status "op" Value: "new-Address". Status "target_uri" identifies: The new Public Address once it is allocated. Example 1 Request: Create a new Public Address named Load Balanced. <pre> POST /vdcs/vdc001 Host: example.com Authorization: Basic xxxxxxxxxxxxxxxxxxx Accept: application/vnd.com.sun.cloud.PublicAddress+json Content-Length: nnn Content-Type: application/vnd.com.sun.cloud.PublicAddress+json X-Cloud-Specification-Version: 0.1 { "name" : "Load Balanced" } </pre>Example 1 Response: <pre> HTTP/1.1 202 Accepted Content-Type: application/vnd.com.sun.cloud.Status+json Content-Length: nnn { "op": "new-Address", "progress": 100, "target_uri": "/addresses/107.236.66.83", "status_uri": "/statuses?op=na&r=0389.aa6", "status": 201 } </pre><h1><a name='Create_Volume'></a> Create Volume </h1> Request the creation of a WebDAV volume on the storage service for the owner of this VDC. Most of the fields of a Volume resource are automatically set in the course of its use; the only field required at creation time is its logical name. The request is a POST to the URI of the VDC; the Content-Type MUST be "application/vnd.com.sun.cloud.Volume+json" Synopsis: POST { URI of VDC } 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 volume-creation progress. Response Status: 202, 400, 401, 403, 404. Status "op" Value: "new-Volume". Status "target_uri" identifies: The new Volume once it is created. Example Request: Create a new Volume named backups. <pre> POST /vdcs/vdc001 Host: example.com Authorization: Basic xxxxxxxxxxxxxxxxxxx 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 { "name" : "backups", "tags" : [ "default" ] } </pre>Example Response: <pre> HTTP/1.1 202 Accepted Content-Type: application/vnd.com.sun.cloud.Status+json Content-Length: nnn { "op": "new-Volume", "progress": 0, "target_uri": "/volumes/1234567890", "status_uri": "/statuses?op=nv&name=backups" } </pre> Copyright © Sun Microsystems, 2009. This work is licensed under <a class='external' href="http://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution 3.0 Unported License</a>

2010-01-11T18:56:00Z

3636