API

grid.loadbalancer.get

From GoGrid



Contents

This call will retrieve one or many load balancer objects from your list of load balancers. This method follows a common get pattern.

Request

URL


Role Based Access Control Permissions

  • Super User
  • System User
  • Billing User
  • Read Only User

Input Request Query Parameters

Required Name Version Type Description
Required api_key 1.0 string An API Key generated by GoGrid.
  sig 1.0 string An MD5 Signature that signs each and every API request. Instructions on how to generate this signature can be found here.
v 1.0 string The version of the API. For more information, see API Versions.
  • For version 1.3, set parameter to 1.3
  id n * string The id(s) of the load balancer(s) to retrieve. If multiple input id parameters are specified, the API will retrieve the set of load balancers whose ids match the input parameter values.
  name n * 1.0 string The name(s) of the load balancer(s) to retrieve. If multiple input name parameters are specified, the API will retrieve the set of load balancers whose names match the input parameter values.
Optional loadbalancer n * 1.0 string The id(s) or name(s) of the load balancer(s) to retrieve. If multiple input loadbalancer parameters are specified, the API will retrieve the set of load balancers whose ids or names match the input parameter values.
 
format 1.0 string The output format of the response. For more information, see Output Formats.
  • For JSON, set parameter to json.
  • For XML, set parameter to xml.
  • For CSV, set parameter to csv.
  • Default is json.

n You can have multiple parameters to retrieve multiple loadbalancers by id, name, or loadbalancer in one API call.

* Only one of these parameters id, name, or loadbalancer is required per get method call. These parameters are exclusive and cannot be mixed in a call.

Sample Request

To get by name: 

https://api.gogrid.com/api/grid/loadbalancer/get
  ?name=My+Load+Balancer
  ... auth parameters...

To get by id: 

https://api.gogrid.com/api/grid/loadbalancer/get
  ?id=203923
  ... auth parameters...

To get multiple by name: 

https://api.gogrid.com/api/grid/loadbalancer/get
  ?name=My+Load+Balancer
  &name=My+Load+Balancer+2
  &name=My+Load+Balancer+3
  &name=My+Load+Balancer+4
  ... auth parameters...

Response


A common get response for Load Balancers.


JSON Response

{
    "list": [{
        "datacenter": {
            "description": "US West 1 Datacenter",
            "id": 1,
            "name": "US-West-1",
            "object": "option"
        },
        "name": "lb02",
        "object": "loadbalancer",
        "os": {
            "description": "The F5 Load Balancer.",
            "id": 1,
            "name": "F5",
            "object": "option"
        },
        "persistence": {
            "description": "",
            "id": 1,
            "name": "None",
            "object": "option"
        },
        "realiplist": [
            {
                "ip": {
                    "datacenter": {
                        "description": "US West 1 Datacenter",
                        "id": 1,
                        "name": "US-West-1",
                        "object": "option"
                    },
                    "id": 65667,
                    "ip": "208.113.110.130",
                    "object": "ip",
                    "public": true,
                    "state": {
                        "description": "IP is reserved or in use",
                        "id": 2,
                        "name": "Assigned",
                        "object": "option"
                    },
                    "subnet": "208.113.110.128/255.255.255.240"
                },
                "object": "ipportpair",
                "port": 80
            },
            {
                "ip": {
                    "datacenter": {
                        "description": "US West 1 Datacenter",
                        "id": 1,
                        "name": "US-West-1",
                        "object": "option"
                    },
                    "id": 65668,
                    "ip": "208.113.110.131",
                    "object": "ip",
                    "public": true,
                    "state": {
                        "description": "IP is reserved or in use",
                        "id": 2,
                        "name": "Assigned",
                        "object": "option"
                    },
                    "subnet": "208.113.110.128/255.255.255.240"
                },
                "object": "ipportpair",
                "port": 80
            }
        ],
        "state": {
            "description": "Loadbalancer state is unknown.",
            "id": 4,
            "name": "Unknown",
            "object": "option"
        },
        "type": {
            "description": "",
            "id": 1,
            "name": "Round Robin",
            "object": "option"
        },
        "virtualip": {
            "ip": {
                "datacenter": {
                    "description": "US West 1 Datacenter",
                    "id": 1,
                    "name": "US-West-1",
                    "object": "option"
                },
                "id": 65669,
                "ip": "208.113.110.132",
                "object": "ip",
                "public": true,
                "state": {
                    "description": "IP is reserved or in use",
                    "id": 2,
                    "name": "Assigned",
                    "object": "option"
                },
                "subnet": "208.113.110.128/255.255.255.240"
            },
            "object": "ipportpair",
            "port": 80
        }
    }],
    "method": "/grid/loadbalancer/get",
    "status": "success",
    "summary": {
        "numpages": 0,
        "returned": 1,
        "start": 0,
        "total": 1
    }
}

XML Response

<gogrid>
  <response method="/grid/loadbalancer/get" status="success">
    <summary total="1" start="0" numpages="0" returned="1"/>
    <list>
      <object name="loadbalancer">
        <attribute name="id"></attribute>
        <attribute name="name">lb02</attribute>
        <attribute name="description"></attribute>
        <attribute name="virtualip">
          <object name="ipportpair">
            <attribute name="ip">
              <object name="ip">
                <attribute name="id">65669</attribute>
                <attribute name="ip">208.113.110.132</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.110.128/255.255.255.240</attribute>
                <attribute name="public">true</attribute>
                <attribute name="datacenter">
                  <object name="option">
                    <attribute name="id">1</attribute>
                    <attribute name="name">US-West-1</attribute>
                    <attribute name="description">US West 1 Datacenter</attribute>
                  </object>
                </attribute>
              </object>
            </attribute>
            <attribute name="port">80</attribute>
          </object>
        </attribute>
        <attribute name="type">
          <object name="option">
            <attribute name="id">1</attribute>
            <attribute name="name">Round Robin</attribute>
            <attribute name="description"></attribute>
          </object>
        </attribute>
        <attribute name="persistence">
          <object name="option">
            <attribute name="id">1</attribute>
            <attribute name="name">None</attribute>
            <attribute name="description"></attribute>
          </object>
        </attribute>
        <attribute name="realiplist">
          <list>
            <object name="ipportpair">
              <attribute name="ip">
                <object name="ip">
                  <attribute name="id">65667</attribute>
                  <attribute name="ip">208.113.110.130</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.110.128/255.255.255.240</attribute>
                  <attribute name="public">true</attribute>
                  <attribute name="datacenter">
                    <object name="option">
                      <attribute name="id">1</attribute>
                      <attribute name="name">US-West-1</attribute>
                      <attribute name="description">US West 1 Datacenter</attribute>
                    </object>
                  </attribute>
                </object>
              </attribute>
              <attribute name="port">80</attribute>
            </object>
            <object name="ipportpair">
              <attribute name="ip">
                <object name="ip">
                  <attribute name="id">65668</attribute>
                  <attribute name="ip">208.113.110.131</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.110.128/255.255.255.240</attribute>
                  <attribute name="public">true</attribute>
                  <attribute name="datacenter">
                    <object name="option">
                      <attribute name="id">1</attribute>
                      <attribute name="name">US-West-1</attribute>
                      <attribute name="description">US West 1 Datacenter</attribute>
                    </object>
                  </attribute>
                </object>
              </attribute>
              <attribute name="port">80</attribute>
            </object>
          </list>
        </attribute>
        <attribute name="os">
          <object name="option">
            <attribute name="id">1</attribute>
            <attribute name="name">F5</attribute>
            <attribute name="description">The F5 Load Balancer.</attribute>
          </object>
        </attribute>
        <attribute name="state">
          <object name="option">
            <attribute name="id">4</attribute>
            <attribute name="name">Unknown</attribute>
            <attribute name="description">Loadbalancer state is unknown.</attribute>
          </object>
        </attribute>
        <attribute name="datacenter">
          <object name="option">
            <attribute name="id">1</attribute>
            <attribute name="name">US-West-1</attribute>
            <attribute name="description">US West 1 Datacenter</attribute>
          </object>
        </attribute>
      </object>
    </list>
  </response>
</gogrid>

CSV Response

# SUCCESS, /grid/loadbalancer/get, TOTAL, 1, START, 0, RETURNED, 1
# id,name,description,virtualip.ip.id,virtualip.ip.ip,virtualip.ip.subnet,virtualip.ip.public,virtualip.port,type.id,type.name,type.description,persistence.id,persistence.name,persistence.description,os.id,os.name,os.description,state.id,state.name,state.descriptionrealiplist.1.ip.id,realiplist.1.ip.ip,realiplist.1.ip.subnet,realiplist.1.ip.public,realiplist.1.port
791,Test,My Load Balancer,138803,216.121.62.34,216.121.62.32/255.255.255.240,true,2300,1,Round Robin,,1,None,,1,F5,The F5 Load Balancer.,1,On,Loadbalancer is enabled and on.138806,216.121.62.37,216.121.62.32/255.255.255.240,true,2400,


Error Codes

Status Code Description
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.
Retrieved from "http://wiki.gogrid.com/wiki/index.php/API:grid.loadbalancer.get"
Personal tools