A common get response for Servers.
JSON Response
{
"list": [{
"description": "test",
"image": {
"description": "CentOS 5.1 (64-bit) w/ MySQL 5.0",
"id": 27,
"name": "centos51_64_mysql",
"object": "option"
},
"ip": {
"id": 500,
"ip": "208.113.75.243",
"object": "ip",
"public": true,
"state": {
"description": "IP is reserved or in use",
"id": 2,
"name": "Assigned",
"object": "option"
},
"subnet": "208.113.75.240/255.255.255.240"
},
"isSandbox": true,
"name": "Image Sandbox Test",
"object": "server",
"os": {
"description": "CentOS Linux 5.1 (64-bit)",
"id": 10,
"name": "CentOS 5.1 (64-bit)",
"object": "option"
},
"ram": {
"description": "SandBox Server with 2GB RAM",
"id": 7,
"name": "2GB",
"object": "option"
},
"state": {
"description": null,
"id": 3,
"name": "Off",
"object": "option"
},
"type": {
"description": "This server does not have a public connection to the Internet.",
"id": 2,
"name": "Database Server",
"object": "option"
}
}],
"method": "/grid/server/list",
"status": "success",
"summary": {
"numpages": 0,
"returned": 1,
"start": 0,
"total": 1
}
}
XML Response
<gogrid>
<response method="/grid/server/list" status="success">
<summary total="1" start="0" numpages="0" returned="1"/>
<list>
<object name="server">
<attribute name="id">364</attribute>
<attribute name="name">Image Sandbox Test</attribute>
<attribute name="description">test</attribute>
<attribute name="ip">
<object name="ip">
<attribute name="id">500</attribute>
<attribute name="ip">208.113.75.243</attribute>
<attribute name="state">
<object name="option">
<attribute name="id">2</attribute>
<attribute name="name">Assigned</attribute>
<attribute name="description">IP is reserved or in use</attribute>
</object>
</attribute>
<attribute name="subnet">208.113.75.240/255.255.255.240</attribute>
<attribute name="public">true</attribute>
</object>
</attribute>
<attribute name="ram">
<object name="option">
<attribute name="id">7</attribute>
<attribute name="name">2GB</attribute>
<attribute name="description">SandBox Server with 2GB RAM</attribute>
</object>
</attribute>
<attribute name="image">
<object name="serverimage">
<attribute name="id">27</attribute>
<attribute name="name">centos51_64_mysql</attribute>
<attribute name="friendlyName"></attribute>
<attribute name="ownerCustomerId"></attribute>
<attribute name="ownerName"></attribute>
<attribute name="description">CentOS 5.1 (64-bit) w/ MySQL 5.0</attribute>
<attribute name="location"></attribute>
<attribute name="price"></attribute>
<attribute name="isActive"></attribute>
<attribute name="isPublic"></attribute>
<attribute name="createdTime"></attribute>
<attribute name="updatedTime"></attribute>
</object>
</attribute>
<attribute name="state">
<object name="option">
<attribute name="id">3</attribute>
<attribute name="name">Off</attribute>
<attribute name="description">Server is in inactive state.</attribute>
</object>
</attribute>
<attribute name="type">
<object name="option">
<attribute name="id">2</attribute>
<attribute name="name">Database Server</attribute>
<attribute name="description">This server does not have a public connection to the Internet.</attribute>
</object>
</attribute>
<attribute name="os">
<object name="option">
<attribute name="id">10</attribute>
<attribute name="name">CentOS 5.1 (64-bit)</attribute>
<attribute name="description">CentOS Linux 5.1 (64-bit)</attribute>
</object>
</attribute>
<attribute name="isSandbox">true</attribute>
</object>
</list>
</response>
</gogrid>
CSV Response
# SUCCESS, /grid/server/list, TOTAL, 1, NUMPAGES, 0, START, 0, RETURNED, 1
# id,name,description,ip.id,ip.ip,ip.state.id,ip.state.name,ip.state.description,ip.subnet,ip.public,ram.id,ram.name,ram.description,image.server.id,image.server.name,image.id,image.name,image.friendlyName,image.os.id,image.os.name,image.os.description,image.ownerCustomerId,image.ownerName,image.architecture.id,image.architecture.name,image.architecture.description,image.type.id,image.type.name,image.type.description,image.state.id,image.state.name,image.state.description,image.description,image.location,image.price,image.isActive,image.isPublic,image.createdTime,image.updatedTime,,state.id,state.name,state.description,type.id,type.name,type.description,os.id,os.name,os.description,isSandbox
364,Image Sandbox Test,test,500,208.113.75.243,2,Assigned,IP is reserved or in use,208.113.75.240/255.255.255.240,true,7,2GB,SandBox Server with 2GB RAM,,,27,centos51_64_mysql,,,,,,,,,,,,,,,,CentOS 5.1 (64-bit) w/ MySQL 5.0,,,,,,,,1,On,Server is in active state.,2,Database Server,This server does not have a public connection to the Internet.,10,CentOS 5.1 (64-bit),CentOS Linux 5.1 (64-bit),true
Error Codes
| 400
| IllegalArgumentException
| Any problems with input parameters will generate an IllegalArgumentException.
|
| 401
| Unauthorized
| This error code will occur when the role tied to the API Key in your request has the wrong Access Controls.
|
| 403
| Authentication Failed
| This error code will occur when your request is not properly signed. Make sure your have a valid API key and secret and that you are properly generating a request signature. Ensure that the clock on the computer from which you are making the request is synchronized woth the GoGrid API Server.
|
| 404
| Not Found
| This error will occur if you have specified a method that does not exist or any other URL does not exists on the API Server.
|
| 500
| UnexpectedError
| These types of errors indicate an internal system problem. Depending on the severity of the error and whether not it is blocking your development, report the error to GoGrid support by emailing the response to apisupport@gogrid.com.
|
