Last updated August 20, 2009 21:26, by Tim Bray
= Cloud API Specification - Requests to Public Address Resources =
The requests documented in this section are directed to ''Public Address'' resources, which represent static IP addresses that are visible to the Public Internet.
__TOC__
= Get Public Address =
Retrieve information about a Public Address.
'''Synopsis:''' GET {URI of Public Address}
'''Request Headers:''' Accept, Authorization, X-Cloud-Client-Specification-Version.
'''Request Message Body:''' N/A.
'''Response Headers:''' Content-Length, Content-Type.
'''Response Message Body:''' Public Address.
'''Response Status:''' 200, 400, 401, 403, 404.
'''Example Request:''' Retrieve information about a Public Address named "Load Balanced".
GET /addresses/107.236.66.83
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Accept: application/vnd.com.sun.cloud.PublicAddress+json
X-Cloud-Client-Specification-Version: 0.1
'''Example Response:'''
HTTP/1.1 200 OK
Content-Type: application/vnd.com.sun.cloud.PublicAddress+json
Content-Length: nnn
{
"name" : "Load Balanced",
"uri" : "/addresses/107.236.66.83",
"ip_address" : "107.236.66.83",
"netmask" : "255.255.0.0",
"gateway" : "107.236.1.1",
"dns" : [ "22.22.22.22", "22.22.22.23" ],
"domain_names" : [ ]
}
= Update Public Address Properties =
Update the specified properties of a Public Address. Only fields actually included in the request message body will be updated, and existing contents of those fields will be completely erased.
'''Synopsis:''' PUT { URI of Public Address }
'''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 update progress.
'''Response Status:''' 202, 400, 401, 403, 404.
'''Status "op" Value:''' "update-Address".
'''Status "target_uri" identifies:''' The Public Address receiving the request.
'''Example Request:''' Update the domain-names associated with a Public Address named "Load Balanced".
PUT /addresses/107.236.66.83
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
X-Cloud-Client-Specification-Version: 0.1
{
"domain_names" : [ "animal.example.com", "vegetable.example.com" ]
}
'''Example Response:'''
HTTP/1.1 202 Accepted
Content-Type: application/vnd.com.sun.cloud.Status+json
Content-Length: nnn
{
"op": "update-Address",
"progress": 100,
"target_uri": "/addresses/107.236.66.83",
"status_uri": "/statuses?id=32e2r2r3r1",
"status": 200
}
= Delete Public Address =
Release allocation of this public address to the owning VDC.
'''Synopsis:''' DELETE { URI of Public Address }
'''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-Address".
'''Status "target_uri" identifies:''' The Public Address being deleted.
'''Example Request:''' Delete an existing Public Address named "Load Balanced"
DELETE /addresses/107.236.66.83
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
X-Compute-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-Address",
"progress": 0,
"target_uri": "/addresses/107.236.66.83",
"status_uri": "/statuses/AddrDel/107.236.66.83"
}
Copyright © Sun Microsystems, 2009. This work is licensed under [http://creativecommons.org/licenses/by/3.0/ Creative Commons Attribution 3.0 Unported License]





