A common get response for Passwords.
JSON Response
{
"list":[
{
"password":"6d5db078",
"object":"password",
"username":"root",
"server":{
"object":"server",
"type":{
"object":"option",
"description":"This server has a public connection to the Internet.",
"name":"Web Server",
"id":1
},
"os":{
"object":"option",
"description":"CentOS Linux 4.4 (32-bit)",
"name":"CentOS 4.4 (32-bit)",
"id":5
},
"description":"Test Web Server",
"image":{
"object":"option",
"description":"CentOS 4.4 (32-bit) w/ Apache 2.2 + PHP5",
"name":"centos44_32_apache22php5",
"id":1
},
"state":{
"object":"option",
"description":"Server is in active state.",
"name":"Started",
"id":1
},
"ram":{
"object":"option",
"description":"Server with 512MB RAM",
"name":"512MB",
"id":1
},
"name":"Test Web Server",
"ip":{
"object":"ip",
"public":true,
"subnet":"216.121.62.32/255.255.255.240",
"ip":"216.121.62.44",
"id":138813
},
"id":2401
},
"id":2546,
"applicationtype":"os"
}
],
"summary":{
"total":1,
"start":0,
"returned":1
},
"status":"success",
"method":"/support/password/get"
}
XML Response
<gogrid>
<response method="/support/password/get" status="success">
<summary total="1" start="0" returned="1"/>
<list>
<object name="password">
<attribute name="id">2546</attribute>
<attribute name="server">
<object name="server">
<attribute name="id">2401</attribute>
<attribute name="name">Test Web Server</attribute>
<attribute name="description">Test Web Server</attribute>
<attribute name="ip">
<object name="ip">
<attribute name="id">138813</attribute>
<attribute name="ip">216.121.62.44</attribute>
<attribute name="subnet">216.121.62.32/255.255.255.240</attribute>
<attribute name="public">true</attribute>
</object>
</attribute>
<attribute name="ram">
<object name="option">
<attribute name="id">1</attribute>
<attribute name="name">512MB</attribute>
<attribute name="description">Server with 512MB RAM</attribute>
</object>
</attribute>
<attribute name="image">
<object name="serverimage">
<attribute name="id">1</attribute>
<attribute name="name">centos44_32_apache22php5</attribute>
<attribute name="friendlyName"></attribute>
<attribute name="description">CentOS 4.4 (32-bit) w/ Apache 2.2 + PHP5</attribute>
<attribute name="location"></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">1</attribute>
<attribute name="name">Started</attribute>
<attribute name="description">Server is in active state.</attribute>
</object>
</attribute>
<attribute name="type">
<object name="option">
<attribute name="id">1</attribute>
<attribute name="name">Web Server</attribute>
<attribute name="description">This server has a public connection to the Internet.</attribute>
</object>
</attribute>
<attribute name="os">
<object name="option">
<attribute name="id">5</attribute>
<attribute name="name">CentOS 4.4 (32-bit)</attribute>
<attribute name="description">CentOS Linux 4.4 (32-bit)</attribute>
</object>
</attribute>
</object>
</attribute>
<attribute name="applicationtype">os</attribute>
<attribute name="username">root</attribute>
<attribute name="password">6d5db078</attribute>
</object>
</list>
</response>
</gogrid>
CSV Response
# SUCCESS, /support/password/get, TOTAL, 1, START, 0, RETURNED, 1
# id,server.id,server.name,server.description,server.ip.id,server.ip.ip,server.ip.subnet,server.ip.public,server.ram.id,server.ram.name,server.ram.description,server.image.id,server.image.name,server.image.friendlyName,server.image.description,server.image.location,server.image.isActive,server.image.isPublic,server.image.createdTime,server.image.updatedTime,server.state.id,server.state.name,server.state.description,server.type.id,server.type.name,server.type.description,server.os.id,server.os.name,server.os.description,applicationtype,username,password
2546,2401,Test Web Server,Test Web Server,138813,216.121.62.44,216.121.62.32/255.255.255.240,true,1,512MB,Server with 512MB RAM,1,centos44_32_apache22php5,,CentOS 4.4 (32-bit) w/ Apache 2.2 + PHP5,,,,,,1,Started,Server is in active state.,1,Web Server,This server has a public connection to the Internet.,5,CentOS 4.4 (32-bit),CentOS Linux 4.4 (32-bit),os,root,6d5db078
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.
|
